diff --git a/README.md b/README.md index b5f6a08..506cbb6 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,81 @@ Add the repository to your inputs. } ``` +## Roadmap + +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] New name and logo + - [x] New README + - [x] New theme +- [x] Distribution on crates.io +- [x] Distribution on Docker hub +- [x] Image embedding in pasta page +- [x] Custom names file +- [x] Click logo/name to get to root + +### v2.1 + +- [ ] Installation guides + - [x] nix flake +- [ ] Copying embed urls more easily (some button for that) + - [ ] "raw" if it isn't an image, if it is "embed" +- [ ] Api for requesting customized api info +- [ ] Config file support +- [ ] 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 This fork of MicroBin was created by [Schrottkatze](https://schrottkatze.de). diff --git a/TODO.md b/TODO.md deleted file mode 100644 index 559543e..0000000 --- a/TODO.md +++ /dev/null @@ -1,54 +0,0 @@ -# TODO lists - -these are just rough guides tho - -## v2.1 - -- [ ] customizable endpoints - - [ ] create - - [ ] edit - - [ ] info - - [ ] get pastas - - [ ] remove -- [ ] improve remove endpoint - - [ ] disable it -- [ ] client library - - [ ] request .well-known data - - [ ] support most endpoints -- [ ] karton cli - -## v3.0 - -- [ ] internal rewrite & docs -- [ ] design new frontend -- [ ] switch to yew - - [ ] using client lib -- [ ] theme and general config files - - [ ] unified theme format - - [ ] no env configs anymore if possible -- [ ] proper dbs - - [ ] sqlite - - [ ] postgres -- [ ] apis/endpoints - - [ ] IDs, name IDs AND user/pastaname - - [ ] root (and admin) user for root level pastas -- [ ] status/instance health admin dashboard and ap - - [ ] storage - - [ ] db status - - [ ] how up to date - - [ ] stats (users etc) - - [ ] errors - - [ ] loading speeds, performance monitor? - - [ ] memory use -- [ ] auth - - [ ] general auth - - [ ] oidc - - [ ] permssion system & api keys - - [ ] only allow some other users to open pasta - - [ ] access control and editing - - [ ] password protected pastas too -- [ ] features for pastas - - [ ] pw protection - - [ ] better editor - - [ ] markdown pastas - - [ ] optional, opt-in commenting