Categorygithub.com/crazcalm/go-rss-reader
modulepackage
0.1.1
Repository: https://github.com/crazcalm/go-rss-reader.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
12
Dependents
0
Files
378 SLOC

# README

go-rss-reader

Build Status Go Report Card Coverage Status

My attempt at making a terminal rss reader (based off newsbeuter)

Dependencies

  • Sqlite3

Setup

The application assumes that you have two things:

  • ~/.go-rss-reader directory in your home path
  • ~/.go-rss-reader/urls file that lists a rss feed url (one per line)

Build Instructions

  • Clone this repo
  • build _examples/rss-reader.go
  • (recommendation) add rss-reader to your PATH

Commands

All commands are CTRL + char (with the exception of Enter, which allows you to select a feed of an episode).

  • b: Back
  • c: Quit
  • r: Refresh feed
  • a: Refresh all feeds

Gotchas

  • Refreshing all feeds will lock up the screen until the application has finished updating all the feeds. If this lag time bothers you, I would recommend refreshing your feeds individually.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Functions

EpisodeContentInit -- Initializes the Episode content for the Gui.
EpisodesInit -- Episodes Init for the Gui.
FeedsInit -- Feeds Init for the Gui.
QuitEpisodes -- Callback used to quit the Episodes view and return to the feeds view.
QuitPager -- Callback used to quit the pager view and return to the Episodes view.
SelectEpisode -- Callback used to select a feed.
SelectFeed -- Callback used to select an episode.
UpdateFeed -- Updates a single feed.
UpdateFeeds -- Update all feeds being shown.

# Variables

CurrentEpisodeID -- Global reference to the episode ID of the currently viewedor last viewed episode.
CurrentFeedID -- Global container for the current Feed ID.
FeedsData -- Global container for the Feeds.
URLFile -- is the path to the url file.