diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 91781c0..fb250e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,13 +14,13 @@ This project is built with the following tech 1. Clone ``` -git clone https://github.com/ayoayco/cozy-reader.git +git clone https://github.com/ayoayco/cozy.git ``` 2. install dependencies ``` -cd cozy-reader +cd cozy npm install ``` @@ -32,7 +32,7 @@ npm start ## Good first issues -Go to our [issues page](https://github.com/ayoayco/cozy-reader/issues) to watch out for issues we label as "good first issue" or "help wanted" +Go to our [issues page](https://github.com/ayoayco/cozy/issues) to watch out for issues we label as "good first issue" or "help wanted" ## Code of Conduct diff --git a/README.md b/README.md index 6811804..6559082 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -

Cozy Reader 🧸

+

Cozy 🧸

- - Last Commit + + Last Commit
Remove distractions. Save your favorites. Get useful insights.
Cozy is your modern-day reading assistant. @@ -20,21 +20,21 @@ Cozy is your modern-day reading assistant. **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](https://cozy-reader.netlify.app/) address bar. +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](https://cozy.netlify.app/) address bar. **2. One-click Bookmark** 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); })(); +javascript:(function(){ window.open('https://cozy.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-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) | +| ![Screenshot from 2023-05-13 08-31-41](https://github.com/ayoayco/cozy/assets/4262489/9b296d4f-2722-483a-bbc2-431c6b2ae996) | ![Screenshot from 2023-05-12 23-32-08](https://github.com/ayoayco/cozy/assets/4262489/144b74f8-3949-46b9-849c-351e4af0ac12) | **3. One-click Extension then...** diff --git a/package-lock.json b/package-lock.json index d911c7d..ce1cae6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,9 +1,11 @@ { - "name": "@ayoayco/cozy-reader", + "name": "@ayoayco/cozy", + "version": "0.0.1", "lockfileVersion": 2, "requires": true, "packages": { "": { + "version": "0.0.1", "dependencies": { "@astro-reactive/form": "^0.8.1", "@astro-reactive/validator": "^0.3.4", @@ -12,8 +14,7 @@ }, "devDependencies": { "astro": "^2.4.4" - }, - "version": "0.0.1" + } }, "node_modules/@ampproject/remapping": { "version": "2.2.1", @@ -9714,6 +9715,5 @@ "resolved": "https://registry.npmjs.org/zwitch/-/zwitch-2.0.4.tgz", "integrity": "sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==" } - }, - "version": "0.0.1" + } } diff --git a/src/components/address-bar.astro b/src/components/address-bar.astro index 1e3a6d5..8ad00aa 100644 --- a/src/components/address-bar.astro +++ b/src/components/address-bar.astro @@ -27,7 +27,7 @@ const form = new FormGroup([ value: "Get cozy!", }} /> - Star on GitHub diff --git a/src/layouts/layout.astro b/src/layouts/layout.astro index 6fd4729..58363b8 100644 --- a/src/layouts/layout.astro +++ b/src/layouts/layout.astro @@ -3,7 +3,7 @@ import "./reset.css"; export interface Props { title?: string; } -const appTitle = "Cozy Reader"; +const appTitle = "Cozy 🧸"; const { title = "" } = Astro.props; --- diff --git a/src/pages/index.astro b/src/pages/index.astro index 73ab4fa..edecae8 100644 --- a/src/pages/index.astro +++ b/src/pages/index.astro @@ -6,7 +6,7 @@ import Post from "../components/post.astro"; import Layout from "../layouts/layout.astro"; // temporary default content while we don't have any good thing to put yet :) -const defaultUrl = "https://github.com/ayoayco/cozy-reader"; +const defaultUrl = "https://github.com/ayoayco/cozy"; const params = getParams(Astro.url); const url = params?.url || defaultUrl; let article;