From d0c6b3aaad386ebfe8022730a82894f7a3142696 Mon Sep 17 00:00:00 2001 From: sunwoo1524 Date: Sun, 3 Nov 2024 01:30:50 +0900 Subject: [PATCH] Docs: add installation guide and usage to readme --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1cead36..6034ae5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # Mastofeed -Mastodon user to RSS 2.0 feed bridge \ No newline at end of file +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` \ No newline at end of file