diff options
| author | John Conway <john.a.conway@gmail.com> | 2019-05-07 17:46:43 +0100 |
|---|---|---|
| committer | John Conway <john.a.conway@gmail.com> | 2019-05-07 17:46:43 +0100 |
| commit | c9401cdd1839f5506e44aefb8a0625b83caa3427 (patch) | |
| tree | 84c83812c15a9600e87f29e7ef3955ab4f218a96 | |
| parent | 95c9c521f0f6231bb58bef21c8d745ba06d4c25c (diff) | |
| download | feed-nim-c9401cdd1839f5506e44aefb8a0625b83caa3427.tar.gz feed-nim-c9401cdd1839f5506e44aefb8a0625b83caa3427.zip | |
Readme Changes
| -rw-r--r-- | .DS_Store | bin | 0 -> 6148 bytes | |||
| -rw-r--r-- | README.md | 19 | ||||
| m--------- | feed-nim | 17 |
3 files changed, 9 insertions, 27 deletions
diff --git a/.DS_Store b/.DS_Store Binary files differnew file mode 100644 index 0000000..5008ddf --- /dev/null +++ b/.DS_Store @@ -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 diff --git a/feed-nim b/feed-nim deleted file mode 160000 -Subproject b768741af8418a39c4687ff0361d97fa66b8e03 |
