diff --git a/README.md b/README.md index d12fc37..f47721a 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,8 @@ # honey -This will be a dashboard hosted on my homeserver with self-hosted stuff. But, for now... +A sweet dashboard hosted on my homeserver with some self-hosted stuff... -**work in progress** +# Installation +Just put those files at the webroot of your server and **copy `defaults.json` to `config.json`** in `config` directory. -#### Still to do before prod: - -- [x] External config loaded with XHR (app list) -- [x] Apply config for the rest stuff (data shown in More page, default user settings) -- [x] Make 'Security' module functional -- [x] CSS global color variables for easier theming -- [ ] Fix blur flicker on showing/hiding pages -- [x] Open in new tab setting -- [x] Better icon colors in 'More' page -- [x] Work with blocked cookies -- [ ] Minor code optimizations - -blah blah blah \ No newline at end of file +honey is written in **pure** `HTML` `CSS` `JS` so dynamic backend is not required. All operations are done client-side.