From 46113ea693d7a84a5a33cb516c858f53c9a065ab Mon Sep 17 00:00:00 2001 From: Ayo Ayco Date: Fri, 12 May 2023 23:45:43 +0200 Subject: [PATCH] docs: add instructions for one-click browser bookmark --- README.md | 24 +++++++++++++++++++++--- package-lock.json | 2 +- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b42a0a1..af00b04 100644 --- a/README.md +++ b/README.md @@ -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/) - \ No newline at end of file +## 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. diff --git a/package-lock.json b/package-lock.json index 5b8647e..853af31 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5 +1,5 @@ { - "name": "@ayoayco/cozy-reader", + "name": "cozy-reader", "lockfileVersion": 2, "requires": true, "packages": {