From 46113ea693d7a84a5a33cb516c858f53c9a065ab Mon Sep 17 00:00:00 2001 From: Ayo Ayco Date: Fri, 12 May 2023 23:45:43 +0200 Subject: [PATCH 1/7] 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": { From 00c4002443290cfb6468ab417247e255a0155576 Mon Sep 17 00:00:00 2001 From: Ayo Ayco Date: Fri, 12 May 2023 23:51:34 +0200 Subject: [PATCH 2/7] docs: add screenshots --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index af00b04..4a0d7c3 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ Store all your favorite online articles for safe-keeping. That's it. That's the 👉 [**cozy-reader.netlify.app/**](https://cozy-reader.netlify.app/) +| Cozy | Actual | +|--------|--------| +| ![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 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. From ae4e99fe0cfec4c17b04bf8094bb2ad8c2cca0a2 Mon Sep 17 00:00:00 2001 From: Ayo Ayco Date: Sat, 13 May 2023 08:26:11 +0200 Subject: [PATCH 3/7] chore: format README --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4a0d7c3..f4c1418 100644 --- a/README.md +++ b/README.md @@ -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. + + From c8b9026f394382a8a461309f0cf9e75d34bcc930 Mon Sep 17 00:00:00 2001 From: Ayo Ayco Date: Sat, 13 May 2023 08:29:59 +0200 Subject: [PATCH 4/7] chore: explain bookmarklets a bit on the README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f4c1418..c4a6056 100644 --- a/README.md +++ b/README.md @@ -18,17 +18,19 @@ It's simple. When you open an article and want to turn it into a more cozy readi **2. One-click Bookmark** -You can create a new bookmark titled 'Get cozy!' and put the following as value for the URL: +A bookmarklet could run a script to open the current page for you on Cozy. You can create this 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); })(); ``` +This is possible on all major browsers, including Safari on iOS (where I personally use this often). Some screenshots: + | 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?* +*Oh, you don't want a bookmark?* **3. One-click Extension then...** From 89679a8af50ed17d715b95d0599ac84618f6a4d0 Mon Sep 17 00:00:00 2001 From: Ayo Ayco Date: Sat, 13 May 2023 08:35:27 +0200 Subject: [PATCH 5/7] feat: link to repo --- README.md | 2 +- src/components/address-bar.astro | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c4a6056..0eca18a 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ This is possible on all major browsers, including Safari on iOS (where I persona | 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) | +| ![Screenshot from 2023-05-13 08-31-41](https://github.com/ayoayco/cozy-reader/assets/4262489/9b296d4f-2722-483a-bbc2-431c6b2ae996) | ![Screenshot from 2023-05-12 23-32-08](https://github.com/ayoayco/cozy-reader/assets/4262489/144b74f8-3949-46b9-849c-351e4af0ac12) | *Oh, you don't want a bookmark?* diff --git a/src/components/address-bar.astro b/src/components/address-bar.astro index 5763e19..48c4172 100644 --- a/src/components/address-bar.astro +++ b/src/components/address-bar.astro @@ -27,6 +27,7 @@ const form = new FormGroup([ value: "Get cozy!", }} /> + Star on GitHub From c309201a005ea2cbaeb9234bc4094f3b3d7f8657 Mon Sep 17 00:00:00 2001 From: Ayo Ayco Date: Sat, 13 May 2023 08:55:41 +0200 Subject: [PATCH 7/7] chore: update readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0eca18a..1a0903c 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,6 @@ This is possible on all major browsers, including Safari on iOS (where I persona **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. - +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. PRs welcome forever. +🧸