48 lines
1.7 KiB
Markdown
48 lines
1.7 KiB
Markdown
<h1 align="center">Cozy 🧸</h1>
|
|
<p align="center">
|
|
<a href="https://github.com/ayoayco/cozy">
|
|
<img alt="Last Commit" src="https://img.shields.io/github/last-commit/ayoayco/cozy?logo=github" />
|
|
</a><br />
|
|
Remove distractions. Save your favorites. Get useful insights.<br />
|
|
Cozy is your modern-day reading assistant.
|
|
</p>
|
|
|
|
## Roadmap
|
|
| Feature | Status |
|
|
| --- | --- |
|
|
| Remove distractions| Done |
|
|
| Save to a Reading Library | In-Progress |
|
|
| PWA: Offline access to library | |
|
|
| AI insights | |
|
|
| Browser Extensions | |
|
|
|
|
## 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](https://cozy-reader.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); })();
|
|
```
|
|
|
|
This is possible on all major browsers, including Safari on iOS (where I personally use this often). Some screenshots:
|
|
|
|
| Firefox | Chrome |
|
|
| --- | --- |
|
|
|  |  |
|
|
|
|
**3. One-click Extension then...**
|
|
|
|
It doesn't exist yet... I'll probably get to creating a browser extension at some point. But for now, PRs welcome! :)
|
|
|
|
## Contributing
|
|
|
|
Speaking of PRs being welcome, see our [CONTRIBUTING guide](/CONTRIBUTING.md).
|
|
|
|
🧸
|
|
|