From c9401cdd1839f5506e44aefb8a0625b83caa3427 Mon Sep 17 00:00:00 2001 From: John Conway Date: Tue, 7 May 2019 17:46:43 +0100 Subject: Readme Changes --- .DS_Store | Bin 0 -> 6148 bytes README.md | 19 +++++++++---------- feed-nim | 1 - 3 files changed, 9 insertions(+), 11 deletions(-) create mode 100644 .DS_Store delete mode 160000 feed-nim diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000..5008ddf Binary files /dev/null and b/.DS_Store differ diff --git a/README.md b/README.md index 0bd2e89..a3ed20a 100644 --- a/README.md +++ b/README.md @@ -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 - -loadAtom(filename: string): Atom 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. -getAtom(url: string): Atom Gets the Atom from the specified _url_ - -loadRSS(filename: string): RSS Loads the RSS from the given _filename_ +## Usage -getRSS(url: string): RSS Gets the RSS from the specified _url_ +loadAtom(filename: string): Atom Loads the Atom from the given _filename_
+getAtom(url: string): Atom Gets the Atom from the specified _url_
-loadJsonFeed(filename: string): JSONfeed Loads the JSONFeed from the given _filename_ +loadRSS(filename: string): RSS Loads the RSS from the given _filename_
+getRSS(url: string): RSS Gets the RSS from the specified _url_
-getJsonFeed(url: string): JSONfeed JsonFeed = JSONFeed from the specified _url_ +loadJsonFeed(filename: string): JSONfeed Loads the JSONFeed from the given _filename_
+getJsonFeed(url: string): JSONfeed JsonFeed = JSONFeed from the specified _url_
\ No newline at end of file diff --git a/feed-nim b/feed-nim deleted file mode 160000 index b768741..0000000 --- a/feed-nim +++ /dev/null @@ -1 +0,0 @@ -Subproject commit b768741af8418a39c4687ff0361d97fa66b8e036 -- cgit v1.2.3