Skip to content

Commit 8180bff

Browse files
committed
Update README.md
1 parent eebf747 commit 8180bff

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fnmdias%2FFeedKit%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/nmdias/FeedKit)
55
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fnmdias%2FFeedKit%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/nmdias/FeedKit)
66

7-
FeedKit is a Swift library for Parsing and Generating RSS, Atom, and JSON feeds.
7+
FeedKit is a Swift library for Reading and Generating RSS, Atom, and JSON feeds.
88

99
### FeedKit v10 (Beta) :warning:
1010

@@ -31,13 +31,13 @@ It should be stable enough :eyes:, but if stable enough is not enough, consider
3131
- [x] [Documentation](https://swiftpackageindex.com/nmdias/FeedKit/main/documentation/feedkit)
3232
- [x] Unit Tests
3333

34-
## Feed Parsing
34+
## Feed Reader
3535

36-
The fetching, loading and parsing of feeds can be made with a **dedicated** type, such as `RSSFeed`, `AtomFeed` and `JSONFeed`, or a **universal** type `Feed`.
36+
Feed reading can be made with a **dedicated** type, such as `RSSFeed`, `AtomFeed` and `JSONFeed`, or a **universal** type `Feed`.
3737

3838
### Dedicated
3939

40-
When you know the type of feed to be parsed, use a dedicated type.
40+
When you know the type of feed to be read, use a dedicated type.
4141

4242
```swift
4343
try await RSSFeed(urlString: "https://developer.apple.com/news/rss/news.rss")
@@ -47,13 +47,13 @@ try await RSSFeed(urlString: "https://developer.apple.com/news/rss/news.rss")
4747

4848
When you don't know the type of feed, use the universal `Feed` enum type.
4949

50-
The `Feed` enum type handles **RSS**, **Atom** and **JSON** feeds and will determine the type of feed before parsing occurs.
50+
The `Feed` enum type handles **RSS**, **Atom** and **JSON** feeds and will determine the type of feed before reading, parsing and decoding occurs.
5151

5252
```swift
53-
// Fetch and parse any feed type
53+
// Read any type of feed
5454
let feed = try await Feed(urlString: "https://surprise.me/feed")
5555

56-
// Use a switch to get the resulting parsed feed model
56+
// Use a switch to get the resulting feed model
5757
switch feed {
5858
case let .atom(feed): // An AtomFeed instance
5959
case let .rss(feed): // An RSSFeed instance
@@ -63,7 +63,7 @@ case let .json(feed): // A JSONFeed instance
6363

6464
### Initializers
6565

66-
All feed types have multiple initializers. They provide a flexible way to fetch and parse feeds from the most common sources.
66+
All feed types have multiple initializers. They provide a flexible way to read feeds from the most common sources.
6767

6868
<details>
6969
<summary>Show</summary>

0 commit comments

Comments
 (0)