sunwoo1524/mastofeed
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Docs: add installation guide and usage to readme

Browse source
This commit is contained in:
sunwoo1524 2024-11-03 01:30:50 +09:00
parent 245f9a4aaf
commit d0c6b3aaad
1 changed files with 20 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,2 +1,21 @@
# Mastofeed # Mastofeed
Mastodon user to RSS 2.0 feed bridge Mastodon user to RSS 2.0 feed bridge
## Installation
```bash
# make venv and activate it
python -m venv venv
source ./venv/bin/activate # ./venv/Scripts/activate
# install packages
pip install -r requirements.txt
# run
fastapi run main.py
# run with different port
# fastapi run main.py --port 8001
```
## Usage
If you are running Mastofeed on `127.0.0.1:8000` and want to get the feed for `@example@mastodon.tld`, go to `http://127.0.0.1:8000/feed/@example@mastodon.tld`