Skip to content

Commit a9a931a

Browse files
committed
Update README
1 parent d917508 commit a9a931a

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,23 @@ FeedKit **[`v10`](https://github.com/nmdias/FeedKit)** is currently in **beta**.
3030

3131
## Usage
3232

33-
The `Feed`, `RSSFeed`, `AtomFeed` and `JSONFeed` types makes it easy to fetch and parse feeds. Here's how to use them:
33+
The fetching, loading and parsing of feeds can be made with either a **dedicated** type, such as `RSSFeed`, `AtomFeed` and `JSONFeed`, or an **universal** type `Feed` that determines the type of feed before parsing occurs.
3434

35-
### Dedicated Feed Parser
35+
Here's how to use them:
3636

37-
If you know the type of feed that is expected, you can use a dedicated type, such as:
37+
### Dedicated
38+
39+
When you know the type of feed to be parsed, a dedicated type is recomended.
3840

3941
```swift
4042
try await RSSFeed(urlString: "https://developer.apple.com/news/rss/news.rss")
4143
```
4244

43-
### Universal Feed Parser
45+
### Universal
4446

45-
If you don't know the type of feed, use the `Feed` enum.
47+
When you don't know the type of feed, use the universal `Feed` type.
4648

47-
The `Feed` enum type allows you to handle various feed formats, including **RSS**, **Atom** and **JSON** feeds. This makes it a versatile solution for parsing any type of feed.
49+
The `Feed` enum type handles various feed formats, including **RSS**, **Atom** and **JSON** feeds. This makes it a versatile solution for parsing any type of feed.
4850

4951
```swift
5052
// Fetch and parse a feed

0 commit comments

Comments
 (0)