Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
levysoft authored Jan 14, 2024
1 parent 4093a8f commit 042a99a
Showing 1 changed file with 33 additions and 4 deletions.
37 changes: 33 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,44 @@ This Python script (`rss_finder.py`) is designed to find RSS or Atom feeds on a
```bash
pip install html5lib feedparser requests

or install dependencies:

`pip install -r requirements.txt`

## Installation
To set up the development environment:

1. Clone the repository:

`git clone https://github.com/levysoft/RSS-Finder`

2. Enter the project directory:

`cd RSS-Finder`

3. Create a Python virtual environment:

`python3 -m venv venv`

4. Activate the virtual environment:

- On Windows:
```
.\venv\Scripts\activate
```
- On Unix or MacOS:
```
source venv/bin/activate
```
5. Install dependencies:

`pip install -r requirements.txt`

## Usage
To use the script, run it with a single argument: the URL of the website you want to find the feed for. For example:

`python3 rss_finder.py https://example.com`

or install dependencies:

`pip install -r requirements.txt`

## How it Works

The script makes a request to the given URL and parses the HTML response. It then searches for <link> elements that point to Atom or RSS feeds. If none are found, it tries appending common feed paths to the base URL to see if any valid feeds exist.
Expand Down

0 comments on commit 042a99a

Please sign in to comment.