diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 9 insertions, 10 deletions
@@ -1,16 +1,15 @@ # 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) +A feed parsing module for Nim, which parses RSS, Atom, and JSONfeed syndication formats. This has been substantional 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_ +It has not been tested, has no tests, and is mostly wriiten by an inexperienced dope who barely understands Nim. Use at your own risk. -<code>getAtom(url: string): Atom</code> Gets the Atom from the specified _url_ - -<code>loadRSS(filename: string): RSS</code> Loads the RSS from the given _filename_ +## Usage -<code>getRSS(url: string): RSS</code> Gets the RSS from the specified _url_ +<code>loadAtom(filename: string): Atom</code> Loads the Atom from the given _filename_<br> +<code>getAtom(url: string): Atom</code> Gets the Atom from the specified _url_<br> -<code>loadJsonFeed(filename: string): JSONfeed</code> Loads the JSONFeed from the given _filename_ +<code>loadRSS(filename: string): RSS</code> Loads the RSS from the given _filename_<br> +<code>getRSS(url: string): RSS</code> Gets the RSS from the specified _url_<br> -<code>getJsonFeed(url: string): JSONfeed </pre>JsonFeed = JSONFeed from the specified _url_ +<code>loadJsonFeed(filename: string): JSONfeed</code> Loads the JSONFeed from the given _filename_<br> +<code>getJsonFeed(url: string): JSONfeed </pre>JsonFeed = JSONFeed from the specified _url_<br>
\ No newline at end of file |