Skip to content

Commit b6105d7

Browse files
committed
Update README
1 parent 18b35ed commit b6105d7

File tree

1 file changed

+28
-6
lines changed

1 file changed

+28
-6
lines changed

README.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ This is a Django app that creates filtered RSS feeds. It does this by filtering
44

55
It comes with one view that returns the filtered feed XML, as well as Django Admin configuration to make it possible and easy to self-host your own instance of django-rss-filter. It does not come with views to create or edit filtered feeds; this can be done using the Django Admin.
66

7+
## What is this?
8+
9+
This is a plugin (an "app") for the Django web framework. It is **not a standalone application** ready to deploy, and requires a Django project to run.
10+
11+
**If you are a Django developer:** You're in the right place! Skip to the "Getting started" section to integrate this app into your project.
12+
13+
**If you just want a simple, ready-to-run RSS filtering server:** Simply use https://www.rssfilter.com which has user-friendly ways to create and edit filtered RSS feeds.
14+
715
## Getting started
816

917
All instructions use [uv](https://docs.astral.sh/uv/), but should work just as well with pip or Poetry for example.
@@ -29,16 +37,30 @@ This will get you up and running with a working Admin site at http://127.0.0.1:8
2937

3038
Then follow the first four steps to add django-rss-filter to your Django project.
3139

32-
## Example project
40+
## How to run the example project
3341

3442
There's an example Django project using django-rss-filter under `example/`.
3543

36-
1. `cd example`
37-
2. `uv run ./manage.py migrate`
38-
3. `uv run ./manage.py createsuperuser`
39-
4. `uv run ./manage.py runserver`
44+
All instructions use [uv](https://docs.astral.sh/uv/), but should work just as well with pip or Poetry for example.
45+
46+
1. **Clone this repository and navigate into the example project folder:**
47+
```sh
48+
git clone https://github.com/loopwerk/django-rss-filter.git
49+
cd django-rss-filter/example
50+
```
51+
52+
2. **Set up the database and create an admin user:**
53+
```sh
54+
uv run ./manage.py migrate
55+
uv run ./manage.py createsuperuser
56+
```
57+
58+
3. **Run the server:**
59+
```sh
60+
uv run ./manage.py runserver
61+
```
4062

41-
You can then go to http://127.0.0.1:8000/admin/ to create a feed, which you can then access at http://127.0.0.1:8000/[feed_uuid]/.
63+
4. **You're done!** You can now go to http://127.0.0.1:8000/admin/ to create a feed using the superuser account you just created. You can then access the filtered feed at `http://127.0.0.1:8000/[feed_uuid]/`.
4264
4365
## Settings
4466

0 commit comments

Comments
 (0)