ayo/cozy
ayo/cozy
1
Fork 0
Code Issues 2 Pull requests 1 Projects Releases Packages Wiki Activity Actions

chore: format README

Browse source
This commit is contained in:
Ayo Ayco 2023-05-13 08:26:11 +02:00
parent 00c4002443
commit ae4e99fe0c
1 changed files with 10 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -8,11 +8,15 @@ Store all your favorite online articles for safe-keeping. That's it. That's the
|--------|--------|
| ![cozy](https://github.com/ayoayco/cozy-reader/assets/4262489/802f25ae-d970-4df4-8b87-f65cbc7fe24c) | ![actual](https://github.com/ayoayco/cozy-reader/assets/4262489/dc7ab81f-8353-4d7b-9388-f08a3772b9d4) |
## Usage - Copy, Paste
## Usage / Options
**1. 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
*Oh, you're too lazy for that?*
**2. One-click Bookmark**
You can create a new bookmark titled 'Get cozy!' and put the following as value for the URL:
@ -24,8 +28,10 @@ javascript:(function(){ window.open('https://cozy-reader.netlify.app/?url=%27 +
| --- | --- |
| ![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?*
## You don't want a bookmark? - One-click Extension then...
**3. 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.