README: reorganize TODOs to roadmap

This commit is contained in:
Schrottkatze 2023-03-06 12:12:47 +01:00
parent 5d0f73a5f3
commit e3a5527a8c

View file

@ -20,52 +20,78 @@ This is a fork of [MicroBin](https://github.com/szabodanika/microbin).
- Styling via [water.css](https://github.com/kognise/water.css) - Styling via [water.css](https://github.com/kognise/water.css)
- Customizable endpoints - Customizable endpoints
## TODOs: ## Roadmap
- [x] removed light mode This is only a rough time guide for what to get done by which version, nothing fixed.
### v2.0
- [x] Removed light mode
- [x] Rebrand - [x] Rebrand
- [x] New name and logo - [x] New name and logo
- [x] New README - [x] New README
- [ ] installation guides
- [ ] Website
- [ ] Official central instance
- [ ] Donation thing?
- [ ] Distribution
- [ ] nixpkgs
- [x] crates.io
- [x] Docker hub
- [ ] Various other distribution specific repositories?
- [ ] Quality
- [ ] Tests
- [x] New theme - [x] New theme
- [ ] Proper database (_seriously, json isn't a database_) - [x] Distribution on crates.io
- [ ] Proper auth and permissions (_so a single user can also use it and send links_) - [x] Distribution on Docker hub
- [ ] multi-user - [x] Image embedding in pasta page
- [x] Click logo/name to get to root - [x] Custom names file
- [x] Click logo/name to get to root
- [ ] Customizability ### v2.1
- [ ] Customizable keys (_so you can make fixed pastas_)
- [x] Customizable wordset
- [ ] Non-env/args configurations
- [ ] further endpoint configuration
- [x] customizable `pasta`, `url` and `raw` endpoints
- [ ] simplified media embed endpoints (/file/$id or /embed/$id by default? maybe with compression?)
- [ ] disable remove
- [ ] make root page a redirect and root based redirect
- [ ] easy to customize logo, icon etc.
- [ ] simplified themeing (only colors etc)
- [ ] Features - [ ] Installation guides
- [ ] encrypted pastas - [ ] Copying embed urls more easily (some button for that)
- [ ] image embeds - [ ] Api for requesting customized url info
- [x] in pasta view - [ ] Config file support
- [ ] easy to copy image embed url - [ ] Markdown pastas
- [ ] Markdown pastas
### v2.2
- [ ] Proper docs
- [ ] Improved rustdoc
- [ ] Non-web client library
- [ ] CLI client
- [ ] Easier customization of instance names and logos
- [ ] Easier basic themeing
- [ ] Colors
- [ ] Corner rounding
### v2.3
- [ ] Encrypted pastas
### v3.0
- [ ] Deprecate JSON db, replace with SQLite
- [ ] Rework internal data structures
- [ ] Map custom keys to ids
- [ ] Make hash ids, names and custom keys usable at once
- [ ] Users
- [ ] Reporting pastas
- [ ] Admin panel
- [ ] Improve remove api
- [ ] Status/health/info improvements
- [ ] Storage thats left
- [ ] Db status
- [ ] Pastas on the instance
- [ ] Users
- [ ] Errors
### future
- [ ] Federation
- [ ] Requesting pastas from other instances
- [ ] When cli is complete, set default instance to route requests over
- [ ] Fine grained permissions
- [ ] Postgresql db support
- [ ] Pasta comments?
### not related to features, therefor not versioned
- [ ] Official central instance
- [ ] Donation setup?
- [ ] Distribution on nixpkgs
- [ ] Website
## Contact ## Contact