feedkit

About FeedKit

FeedKit is a powerful library that allows developers to easily consume and parse RSS and Atom feeds in their iOS or macOS applications. This library simplifies the process of fetching and parsing feeds, providing a convenient way to access the latest content from blogs, news sites, podcasts, and more.

Features

  • Effortlessly fetch and parse RSS and Atom feeds
  • Automatically handle asynchronous network requests
  • Support for authentication-protected feeds
  • Simple feed filtering and sorting options
  • Customizable parsing and data handling
  • Easy integration with existing iOS or macOS projects

Installation

To install FeedKit in your iOS or macOS project, you can use CocoaPods or include the framework manually. Here is how you can get started:

Using CocoaPods

To integrate FeedKit using CocoaPods, add the following line to your Podfile:

pod 'FeedKit'

Then run the command pod install in your project directory to install the dependency.

Manual Installation

If you prefer to install FeedKit manually, follow these steps:

  • Download the latest release of FeedKit from the official GitHub repository.
  • Drag and drop the framework into your Xcode project.
  • In the General settings for your target, add the FeedKit framework to the “Frameworks, Libraries, and Embedded Content” section.

Getting Started

After installing FeedKit, you are ready to start consuming and parsing feeds in your application. Here’s a basic example to get you started:

Fetching and Parsing a Feed

First, import the FeedKit framework:

import FeedKit

Then, create an instance of FeedParser and provide it with the feed URL you want to parse:

let feedURL = URL(string: "https://example.com/feed")!
let parser = FeedParser(URL: feedURL)

You can then fetch and parse the feed using the parse() method:

parser.parse({ (result) in
    switch result {
    case .success(let feed):
        // Handle the parsed feed object
    case .failure(let error):
        // Handle any parsing errors
    }
})

Make sure to handle both success and failure cases accordingly.

Documentation

For detailed documentation on how to use FeedKit and its various features, please refer to the official wiki on GitHub.

Contributing

We welcome contributions to improve FeedKit. If you find any issues or have ideas for new features, please open an issue or submit a pull request on the official GitHub repository.

License

FeedKit is released under the MIT License. See the LICENSE file for more information.