From e23cbf0bb2d7cc27a5b9ea285c77c31cbad0e369 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Sun, 10 Apr 2022 18:43:16 -0400 Subject: [PATCH 1/8] Raw Links -> Link References --- README.md | 43 +++++++++++++++++++++++++++++++++---------- 1 file changed, 33 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 75cc7ad..e9a72fd 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ # bookay -[![Build Status](https://github.com/jaynetics/bookay/workflows/tests/badge.svg)](https://github.com/jaynetics/bookay/actions) +[![Badge Build]][Actions] bookay is a set of free, open-source tools for self-hosting your bookmarks. -[ - ![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) + [![Showcase Preview]][Showcase] ## Why? @@ -18,9 +14,9 @@ bookay is a set of free, open-source tools for self-hosting your bookmarks. ## Features -- easily deployed [backend](./server/) -- customizable, keyboard-friendly [browser plugin](./plugin/) -- lightweight (~50 kB) [web app](./webapp/) +- easily deployed [backend] +- customizable, keyboard-friendly [browser plugin] +- lightweight (~50 kB) [web app] - support for nested folders - data import and export - scan for dupes and broken links @@ -29,4 +25,31 @@ bookay is a set of free, open-source tools for self-hosting your bookmarks. ## Getting started -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. +Deploy bookay as a free (hobby tier) app on Heroku: + +[![Badge Heroku]][Heroku] + + + + +[Actions]: https://github.com/jaynetics/bookay/actions +[Heroku]: https://heroku.com/deploy?template=https://github.com/jaynetics/bookay + + + + +[Badge Heroku]: https://www.herokucdn.com/deploy/button.svg +[Badge Build]: https://github.com/jaynetics/bookay/workflows/tests/badge.svg + + + + +[Backend]: server/ +[Browser Plugin]: plugin/ +[Web App]: webapp/ + + + + +[Showcase Preview]: https://user-images.githubusercontent.com/10758879/113178657-1528d000-924f-11eb-9a02-2c0e4e504074.png +[Showcase]: https://user-images.githubusercontent.com/10758879/113178042-77350580-924e-11eb-820f-298da2a2631d.png From c9f208d50faefe9c772361636391829788907f0f Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Sun, 10 Apr 2022 18:45:15 -0400 Subject: [PATCH 2/8] Formatted Header --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e9a72fd..58ea5c9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ -# bookay +# bookay [![Badge Build]][Actions] [![Badge Heroku]][Heroku] -[![Badge Build]][Actions] +*A Tools For* ***Self-Hosting*** *Your* ***Bookmarks*** -bookay is a set of free, open-source tools for self-hosting your bookmarks. [![Showcase Preview]][Showcase] @@ -27,7 +26,7 @@ bookay is a set of free, open-source tools for self-hosting your bookmarks. Deploy bookay as a free (hobby tier) app on Heroku: -[![Badge Heroku]][Heroku] + From 594dc466d619ab5dacf1b8ee5a14d22532d77269 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Sun, 10 Apr 2022 18:47:03 -0400 Subject: [PATCH 3/8] Adjusted Spacing --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 58ea5c9..6f4ad8d 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,15 @@ *A Tools For* ***Self-Hosting*** *Your* ***Bookmarks*** +
- [![Showcase Preview]][Showcase] +
+ +[![Showcase Preview]][Showcase] + +
+ +
## Why? @@ -11,6 +18,8 @@ - there is currently no free service that supports nested folders - self-hosting your bookmarks offers the best privacy +
+ ## Features - easily deployed [backend] @@ -29,10 +38,11 @@ Deploy bookay as a free (hobby tier) app on Heroku: + [Actions]: https://github.com/jaynetics/bookay/actions -[Heroku]: https://heroku.com/deploy?template=https://github.com/jaynetics/bookay +[Heroku]: https://heroku.com/deploy?template=https://github.com/jaynetics/bookay 'Deploy Using The Free ( Hobby ) Tier On Heroku' From 7dc87da5e5864b653565d3693b305631771d1128 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Sun, 10 Apr 2022 18:49:21 -0400 Subject: [PATCH 4/8] Adjusted Formatting --- README.md | 33 +++++++++++++++++++++------------ 1 file changed, 21 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 6f4ad8d..fc3221c 100644 --- a/README.md +++ b/README.md @@ -12,24 +12,33 @@
-## Why? +## Why -- 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 +- 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] -- customizable, keyboard-friendly [browser plugin] -- lightweight (~50 kB) [web app] -- 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 ## Getting started From 55ad24fa1763915b186f82309d5defaaf16e7787 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?= <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Sun, 10 Apr 2022 18:50:43 -0400 Subject: [PATCH 5/8] Adjusted Spacing --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index fc3221c..2264074 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ *A Tools For* ***Self-Hosting*** *Your* ***Bookmarks*** +

From d7dad61995c287a0adfb26ad5602c2da7c4f7263 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Fri, 12 Aug 2022 07:36:25 -0400 Subject: [PATCH 6/8] Cleanup Formatting --- README.md | 47 +++++++++++++++++++++++------------------------ 1 file changed, 23 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 2264074..dbf03ff 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,24 @@ -# bookay [![Badge Build]][Actions] [![Badge Heroku]][Heroku] -*A Tools For* ***Self-Hosting*** *Your* ***Bookmarks*** +
+ +
+ +[![Badge Build]][Actions]   [![Badge Heroku]][Heroku] + +
+ +# Bookay + +***Self-Host*** *your* ***Bookmarks***

-
-[![Showcase Preview]][Showcase] +
@@ -21,6 +32,7 @@ - Self - hosting your bookmarks offers the best privacy +

## Features @@ -41,12 +53,7 @@ - Data import and export -## Getting started - -Deploy bookay as a free (hobby tier) app on Heroku: - - - +
@@ -54,21 +61,13 @@ Deploy bookay as a free (hobby tier) app on Heroku: [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 +[Web App]: webapp +[Backend]: server - - -[Badge Heroku]: https://www.herokucdn.com/deploy/button.svg -[Badge Build]: https://github.com/jaynetics/bookay/workflows/tests/badge.svg - - - -[Backend]: server/ -[Browser Plugin]: plugin/ -[Web App]: webapp/ + +[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 - - -[Showcase Preview]: https://user-images.githubusercontent.com/10758879/113178657-1528d000-924f-11eb-9a02-2c0e4e504074.png -[Showcase]: https://user-images.githubusercontent.com/10758879/113178042-77350580-924e-11eb-820f-298da2a2631d.png From 96057e9056029a1d966e283336ecf571aa8bc740 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Fri, 2 Sep 2022 20:03:16 -0400 Subject: [PATCH 7/8] Re-Added Content From Rebase --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index dbf03ff..f886f99 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,17 @@ width = 500 /> +
+
+ +The bookay server includes a webapp by default 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 @@ -62,6 +71,7 @@ [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 From 1445229c924695b2b5a46208326f9bcc80457f93 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Fri, 2 Sep 2022 20:20:08 -0400 Subject: [PATCH 8/8] Adjusted As Requested --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f886f99..3ef804e 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@
-# Bookay +# bookay ***Self-Host*** *your* ***Bookmarks*** @@ -23,7 +23,7 @@

-The bookay server includes a webapp by default and also feeds the browser plugin.
+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. @@ -39,7 +39,7 @@ There are a few free hosting solutions that suffice to run the server. - There is currently no free service that supports nested folders -- Self - hosting your bookmarks offers the best privacy +- Self-hosting your bookmarks offers the best privacy