diff options
| -rw-r--r-- | README.md | 18 |
1 files changed, 16 insertions, 2 deletions
@@ -1,2 +1,16 @@ -# feed-nim -A feed reading module for Nim +# Feed-Nim +A feed parsing module for Nim, which reads RSS, Atom, and JSONfeed syndication formats. This was a re-written and expanded from [Nim-RSS](https://github.com/achesak/nim-rss) + +## Usage + +<code>loadAtom(filename: string): Atom</code> Loads the Atom from the given _filename_ + +<code>getAtom(url: string):</code> Gets the Atom over from the specified _url_ + +<code>loadRSS(filename: string): RSS</code> Loads the RSS from the given _filename_ + +<code>getRSS(url: string):</code> Gets the RSS over from the specified _url_ + +<code>loadJsonFeed(filename: string):JSONfeed</code> Loads the JSONFeed from the given _filename_ + +<code>getJsonFeed(url: string): </pre>JsonFeed = JSONFeed over from the specified _url_ |