From 20dccb1060701ec82ffa948d5643ef24a0da5010 Mon Sep 17 00:00:00 2001 From: Brent Simmons Date: Sat, 30 Dec 2017 10:24:04 -0800 Subject: [PATCH] =?UTF-8?q?Add=20license=20and=20Readme=20from=20RSParser?= =?UTF-8?q?=E2=80=99s=20separate=20open=20source=20project.=20Just=20part?= =?UTF-8?q?=20of=20keeping=20these=20both=20in=20sync.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Frameworks/RSParser/LICENSE | 21 +++++++++++++++++++++ Frameworks/RSParser/README.md | 10 ++++------ 2 files changed, 25 insertions(+), 6 deletions(-) create mode 100644 Frameworks/RSParser/LICENSE diff --git a/Frameworks/RSParser/LICENSE b/Frameworks/RSParser/LICENSE new file mode 100644 index 000000000..df7407c86 --- /dev/null +++ b/Frameworks/RSParser/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 Brent Simmons + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Frameworks/RSParser/README.md b/Frameworks/RSParser/README.md index 665dffc47..cb477deea 100644 --- a/Frameworks/RSParser/README.md +++ b/Frameworks/RSParser/README.md @@ -1,8 +1,6 @@ # RSParser -(Note: Tests are still incomplete. It’s possible that none of this works.) - -(Also note: this framework is intended to supersede my [RSXML](https://github.com/brentsimmons/RSXML) framework. Use this one instead. Well, once it’s working, that is.) +This framework was developed for [Evergreen](https://github.com/brentsimmons/Evergreen) and is made available here for developers who just need the parsing code. It has no depencies that aren’t provided by the system. ## What’s inside @@ -22,11 +20,11 @@ This framework builds for macOS. It *could* be made to build for iOS also, but I To get the type of a feed, even with partial data, call `FeedParser.feedType(parserData)`, which will return a `FeedType`. -To parse a feed, call `FeedParser.parseFeed(parserData)`, which will return a `ParsedFeed`. Also see related structs: `ParsedAuthor`, `ParsedItem`, `ParsedAttachment`, and `ParsedHub`. +To parse a feed, call `FeedParser.parse(parserData)`, which will return a [ParsedFeed](Feeds/ParsedFeed.swift). Also see related structs: `ParsedAuthor`, `ParsedItem`, `ParsedAttachment`, and `ParsedHub`. -You do *not* need to know the type of feed when calling `FeedParser.parseFeed` — it will figure it out and use the correct concrete parser. +You do *not* need to know the type of feed when calling `FeedParser.parse` — it will figure it out and use the correct concrete parser. -However, if you do want to use a concrete parser directly, see `RSSInJSONParser`, `JSONFeedParser`, `RSSParser`, and `AtomParser`. +However, if you do want to use a concrete parser directly, see [RSSInJSONParser](Feeds/JSON/RSSInJSONParser.swift), [JSONFeedParser](Feeds/JSON/JSONFeedParser.swift), [RSSParser](Feeds/XML/RSSParser.swift), and [AtomParser](Feeds/XML/AtomParser.swift). (Note: if you want to write a feed reader app, please do! You have my blessing and encouragement. Let me know when it’s shipping so I can check it out.)