diff options
| author | John Conway <john.a.conway@gmail.com> | 2019-05-07 17:04:20 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-05-07 17:04:20 +0100 |
| commit | 54a9519799384e1aec857c497c0cafdef59a841f (patch) | |
| tree | d25871aad0b53d49b98810ed67e83aeab6a2f6f3 | |
| parent | 7c622566140bd964c43972eb7c54dbab718bf20c (diff) | |
| download | feed-nim-54a9519799384e1aec857c497c0cafdef59a841f.tar.gz feed-nim-54a9519799384e1aec857c497c0cafdef59a841f.zip | |
Update README.md
| -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_ |