diff --git a/README.md b/README.md index 75cc7ad..3ef804e 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,83 @@ + +
+ +
+ +[![Badge Build]][Actions]   [![Badge Heroku]][Heroku] + +
+ # bookay -[![Build Status](https://github.com/jaynetics/bookay/workflows/tests/badge.svg)](https://github.com/jaynetics/bookay/actions) +***Self-Host*** *your* ***Bookmarks*** + +
+
+ + + + +
+
+ +The bookay server includes a webapp and also feeds the browser plugin.
+There are a few free hosting solutions that suffice to run the server. + +**[Get Started]** with examples and deployment instructions. + +
+ +
+
+ +## Why -bookay is a set of free, open-source tools for self-hosting your bookmarks. +- A bookmarking service is useful if you use varying browsers or devices -[ - ![Screenshot thumbnail showing the webapp and browser plugin]( - https://user-images.githubusercontent.com/10758879/113178657-1528d000-924f-11eb-9a02-2c0e4e504074.png - ) -](https://user-images.githubusercontent.com/10758879/113178042-77350580-924e-11eb-820f-298da2a2631d.png) +- There is currently no free service that supports nested folders -## Why? +- Self-hosting your bookmarks offers the best privacy -- a bookmarking service is useful if you use varying browsers or devices -- there is currently no free service that supports nested folders -- self-hosting your bookmarks offers the best privacy +
+
## Features -- easily deployed [backend](./server/) -- customizable, keyboard-friendly [browser plugin](./plugin/) -- lightweight (~50 kB) [web app](./webapp/) -- support for nested folders -- data import and export -- scan for dupes and broken links -- support for multiple users per instance -- responsiveness and dark mode +- Customizable, keyboard-friendly **[Browser Plugin]** + +- Support for multiple users per instance + +- Lightweight ( `~50 kB` ) **[Web App]** + +- Scan for dupes and broken links + +- Responsiveness and dark mode + +- Support for nested folders + +- Easily deployed **[Backend]** + +- Data import and export + +
+ + + + +[Actions]: https://github.com/jaynetics/bookay/actions +[Heroku]: https://heroku.com/deploy?template=https://github.com/jaynetics/bookay 'Deploy Using The Free ( Hobby ) Tier On Heroku' + +[Browser Plugin]: plugin +[Get Started]: server/README.md#how-to-use +[Web App]: webapp +[Backend]: server + + + -## Getting started +[Badge Heroku]: https://www.herokucdn.com/deploy/button.svg +[Badge Build]: https://img.shields.io/github/workflow/status/jaynetics/bookay/tests?style=for-the-badge&logoColor=white&logo=GitHub&labelColor=bf58ae&color=8c407f -You need to run a bookay server to use bookay. It includes the webapp by default and also feeds the browser plugin. There are a few free hosting solutions that suffice to run the server. See [here](./server/README.md#how-to-use) for examples and deployment instructions.