diff --git a/README.md b/README.md index 38f91b4..944c555 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,70 @@

-mkfd
-Docker Pulls -GitHub Repo stars + mkfd
+ Docker Pulls + GitHub Repo stars

-## Running locally: +## 🏃 Running locally + +### 🍞 Bun installation Visit [bun.sh](https://bun.sh/) for more info -### Bun installation Visit https://bun.sh/ for more info - ```bash curl https://bun.sh/install | bash ``` -### To install dependencies: +### 📦 To install dependencies ```bash bun install ``` -### To run: +### 🚀 To run ```bash bun run index.ts --passkey=your_passkey_here --cookieSecret=your_cookie_secret_here ``` -Access the GUI at `http://localhost:5000/` - -## Running with Docker: - - ### Locally: - - ```bash - docker build -t mkfd . - docker run -p 5000:5000 -v /local/mount/path:/configs -e PASSKEY=your_passkey -e COOKIE_SECRET=your_cookie_secret mkfd - ``` - - ### Dockerhub: - - ```bash - docker pull tbosk/mkfd:latest - docker run -p 5000:5000 -v /local/mount/path:/configs -e PASSKEY=your_passkey -e COOKIE_SECRET=your_cookie_secret tbosk/mkfd:latest - ``` - -## To Do: -- [X] Locally testing subscriptions to feeds -- [ ] Add all possible RSS fields to models -- [X] Add option for parallel iterators -- [ ] Add form validation -- [ ] Add selector suggestion engine -- [X] Add feed preview pane -- [ ] Store/compare feed data to enable timestamping feed items -- [X] Create dockerfile -- [X] Create GUI -- [ ] Utilities - - [X] HTML stripper - - [X] Source url wrapper for relative links -- [ ] Amass contributors +➡️ Access the GUI at `http://localhost:5000/` + +--- + +## 🐳 Running with Docker + +### 🏠 Locally + +```bash +docker build -t mkfd . +docker run -p 5000:5000 -v /local/mount/path:/configs -e PASSKEY=your_passkey -e COOKIE_SECRET=your_cookie_secret mkfd +``` + +### 📥 From Docker Hub + +```bash +docker pull tbosk/mkfd:latest +docker run -p 5000:5000 -v /local/mount/path:/configs -e PASSKEY=your_passkey -e COOKIE_SECRET=your_cookie_secret tbosk/mkfd:latest +``` + +--- + +## 🔧 To Do + +- [X] **Locally** testing subscriptions to feeds +- [ ] Add all possible RSS fields to models +- [X] Add option for parallel iterators +- [ ] Add form validation +- [ ] Add selector suggestion engine +- [X] Add feed preview pane +- [ ] Store/compare feed data to enable timestamping feed items +- [X] Create dockerfile +- [X] Create GUI +- [ ] Utilities + - [X] HTML stripper + - [X] Source URL wrapper for relative links +- [ ] Amass contributors + +
[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=V5LC4XTQDDE82&source=url)