diff --git a/README.md b/README.md index dc6f10b..1e584b6 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,16 @@ An open source file host that you can easily selfhost. Made by the creators of f ![https://raw.githubusercontent.com/filecoffee/filehost/main/assets/git/homepage.png](https://raw.githubusercontent.com/filecoffee/filehost/main/assets/git/homepage.png) -## Simply start your own file host +## Simply start your own file host 🚀 filehost is a one-click (or one-command) setup file host that you can deploy wherever you want. Full control over your own data. No limits. -### Use Railway (one click) +### Use Railway (one-click) (W.i.p) 🚂 Hit the Railway button and have your filehost up and running in a few minutes. The button also supports the project since we get a small referral bonus. [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/pv_x6t?referralCode=QsZ-bg) -### DIY - Docker! +### DIY - Docker! 🐳 Simply run `docker-compose up --build -d` on your server after you've configured the `.env` and it's all up and running. ``` @@ -21,7 +21,7 @@ Note: We're still actively working on the product and is currently in early alph We also recommend forking the project and deploying your forked version to avoid issues when we push updates. You can then easily merge the changes in your forked version. -## Roadmap +## Roadmap 🛣️ - [x] File uploads - [x] Retrieving files - [x] Unit tests @@ -38,6 +38,8 @@ We also recommend forking the project and deploying your forked version to avoid - [ ] File search - [ ] File tagging using AI - [ ] File previews +- [x] Rate limiting +- [x] Slowdown on too many requests - [ ] Advertising support - [ ] NSFW detection and filtering