docs: add instructions for one-click browser bookmark

This commit is contained in:
Ayo Ayco 2023-05-12 23:45:43 +02:00
parent 72aa15f6ce
commit 46113ea693
2 changed files with 22 additions and 4 deletions

View file

@ -4,6 +4,24 @@ Store all your favorite online articles for safe-keeping. That's it. That's the
👉 [**cozy-reader.netlify.app/**](https://cozy-reader.netlify.app/)
<!--
using modern browser features and progressively enhanced user experience
-->
## Usage - Copy, Paste
It's simple. When you open an article and want to turn it into a more cozy reading experience, just copy the url and paste it to the cozy app's address bar.
## Oh, you're too lazy for that? - One-click Bookmark
You can create a new bookmark titled 'Get cozy!' and put the following as value for the URL:
```
javascript:(function(){ window.open('https://cozy-reader.netlify.app/?url=%27 + window.location.href, %27_self%27); })();
```
| Firefox | Chrome |
| --- | --- |
| ![Screenshot from 2023-05-12 23-33-10](https://github.com/ayoayco/cozy-reader/assets/4262489/5f0be296-3a3e-4606-b442-7f4b51163e3c) | ![Screenshot from 2023-05-12 23-32-08](https://github.com/ayoayco/cozy-reader/assets/4262489/144b74f8-3949-46b9-849c-351e4af0ac12) |
## You don't want a bookmark? - One-click Extension then...
It doesn't exist yet... I'll probably get to creating a browser extension at some point. Either that, or I'll write a CONTRIBUTING.md and PRs will be welcome.

2
package-lock.json generated
View file

@ -1,5 +1,5 @@
{
"name": "@ayoayco/cozy-reader",
"name": "cozy-reader",
"lockfileVersion": 2,
"requires": true,
"packages": {