34e32abe51
* chore: add favicon * fix: home article url * fix: prevent duplicated history entry (unencoded & encoded) * fix: prevent own app * remove console.log * fix: prevent showing cached cozy
60 lines
2.8 KiB
Markdown
60 lines
2.8 KiB
Markdown
<h1 align="center"><s>Cozy</s> Uh, we need a new name! See why <a href="https://social.ayco.io/@ayo/110547172702258070">here</a></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>
|
||
<a href="https://github.com/ayoayco/cozy-reader/releases/latest"><img alt="Alpha Version" src="https://img.shields.io/github/package-json/v/ayoayco/cozy?label=alpha" /></a><br />
|
||
Remove distractions. Save for later.<br />
|
||
Cozy is your modern-day reading assistant.<br /><br />
|
||
<a href="https://cozy-reader.netlify.app" target="_blank"><img src="https://raw.githubusercontent.com/ayoayco/cozy/main/.github/assets/screenshot.png" /></a><br />
|
||
<a href="https://cozy-reader.netlify.app" target="_blank">↗ Try the App! ↗</a><br />
|
||
</p>
|
||
|
||
## How is this app different?
|
||
Well here's what I’m building:
|
||
1. An app that just works, no sign ups or setups.
|
||
2. Progressively enhanced experience. Main feature works even without JS. Removing distractions happen on the server and dead clean HTML gets delivered
|
||
3. All your data are cached and does not leave your device; offline access is by default
|
||
4. Cloud-sync will be opt-in, with your choice of provider
|
||
5. Will also explore smart insights, such as:
|
||
1. text summarization
|
||
2. dominant emotion
|
||
3. other sources for lateral reading
|
||
|
||
## Roadmap
|
||
| Feature | Status |
|
||
| --- | --- |
|
||
| Remove distractions| ✅ DONE |
|
||
| Save viewed history | ✅ DONE |
|
||
| Set items as Favorites | 🛠️ In-progress |
|
||
| PWA: full Offline access | |
|
||
| AI insights | |
|
||
| Browser Extensions | |
|
||
| Native Apps | |
|
||
|
||
## 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 [app's](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).
|