Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README Rework #39

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

README Rework #39

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e23cbf0
Raw Links -> Link References
ElectronicsArchiver Apr 10, 2022
c9f208d
Formatted Header
ElectronicsArchiver Apr 10, 2022
594dc46
Adjusted Spacing
ElectronicsArchiver Apr 10, 2022
7dc87da
Adjusted Formatting
ElectronicsArchiver Apr 10, 2022
55ad24f
Adjusted Spacing
ElectronicsArchiver Apr 10, 2022
d7dad61
Cleanup Formatting
ElectronicsArchiver Aug 12, 2022
96057e9
Re-Added Content From Rebase
ElectronicsArchiver Sep 3, 2022
1445229
Adjusted As Requested
ElectronicsArchiver Sep 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 72 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,83 @@

<br>

<div align = center>

[![Badge Build]][Actions]   [![Badge Heroku]][Heroku]
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm not a fan of the extra level of indirection introduced by these link references. i'd rather have my README easy to edit. the indirection would only make sense if the same link was repeated often, IMO.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No.

the indirection would only make sense if the same link was repeated often, IMO.

Just no.

The sole purpose of link references isn't to be used for multiple similar links, it's to decouple the content from the location it's pointing to.

easy to edit

Easy to edit? You call having to edit a link in a reference difficult compared to editing it in the flow of text? Seems quite the opposite considering I added a dedicated section for that, you now don't have to select two varying point in the flow of text but rather just a static start.


<br>

# bookay

[![Build Status](https://github.com/jaynetics/bookay/workflows/tests/badge.svg)](https://github.com/jaynetics/bookay/actions)
***Self-Host*** *your* ***Bookmarks***
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

most typographers would avoid mixing two types of emphasis (bold + italic), but okay

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Show me the stats that make you say most
  • Not that I care, I'm not other people and I do mix when I see it fit.
  • If you don't care then I won't change it I guess?


<br>
<br>


<img
src = 'https://user-images.githubusercontent.com/10758879/113178042-77350580-924e-11eb-820f-298da2a2631d.png'
width = 500
/>

<br>
<br>

The bookay server includes a webapp and also feeds the browser plugin. <br>
There are a few free hosting solutions that suffice to run the server.

**[Get Started]** with examples and deployment instructions.

</div>

<br>
<br>

## 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
<br>
<br>

## 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]**
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the spacing is another thing that makes the README a tiny bit less "maintainable" - when changing such spaced lists, people have to keep the spacing right (a small effort, but in a larger project than this one it could be problematic)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the spacing is another thing that makes the README a tiny bit less "maintainable"

  • Well you can just revert back to the good old README.txt and forget
    about formatting, that would be the easiest to maintain option.

  • When changing it you could also just not adjust it like it,
    then there wouldn't be a difference to how it was before.

a small effort, but in a larger project than this one it could be problematic

This indicates to me the association of big project = big README,
which is usually a type of downfall many projects have and is in
fact not necessary in the slightest.

Btw, what did you expect me to change
to begin with, unorder them again?


- 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

<br>


<!----------------------------------------------------------------------------->

[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


<!---------------------------------[ Badges ]---------------------------------->

## 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.