diff --git a/README.md b/README.md index 7b62ef32..36352841 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,11 @@ [Readest][link-website] is an open-source ebook reader designed for immersive and deep reading experiences. Built as a modern rewrite of [Foliate](https://github.com/johnfactotum/foliate), it leverages [Next.js 15](https://github.com/vercel/next.js) and [Tauri v2](https://github.com/tauri-apps/tauri) to offer a seamless cross-platform experience on macOS, Windows, Linux and Web, with support for mobile platforms coming soon. [![Website][badge-website]][link-website] -[![AGPL Licence][badge-license]](LICENSE) +[![Web App][badge-web-app]][link-web-readest] [![OS][badge-platforms]][link-website] [![][badge-discord]][link-discord]
+[![AGPL Licence][badge-license]](LICENSE) [![Latest release][badge-release]][link-gh-releases] [![Last commit][badge-last-commit]][link-gh-commits] [![Commits][badge-commit-activity]][link-gh-pulse] @@ -30,7 +31,7 @@
- Readest Banner + Readest Banner
@@ -75,13 +76,15 @@ Stay tuned for continuous improvements and updates! Contributions and suggestion ## Screenshots -![Annotations](./data/screenshots/annotations.jpeg) +![Annotations](./data/screenshots/annotations.png) -![Wikipedia](./data/screenshots/wikipedia.jpeg) +![Wikipedia](./data/screenshots/wikipedia.png) -![DeepL](./data/screenshots/deepl.jpeg) +![DeepL](./data/screenshots/deepl.png) -![Dark Mode](./data/screenshots/dark_mode.jpeg) +![Footnote](./data/screenshots/footnote_popover.png) + +![Dark Mode](./data/screenshots/dark_mode.png) --- @@ -165,13 +168,21 @@ Readest is open-source, and contributions are welcome! Feel free to open issues, ## License -Readest is distributed under the AGPL-3.0 License. See the [LICENSE](LICENSE) file for details. +Readest is free software: you can redistribute it and/or modify it under the terms of the [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.html) as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. See the [LICENSE](LICENSE) file for details. + +The following JavaScript libraries are bundled in this software: + +- [foliate-js](https://github.com/johnfactotum/foliate-js), which is MIT licensed. +- [zip.js](https://github.com/gildas-lormeau/zip.js), which is licensed under the BSD-3-Clause license. +- [fflate](https://github.com/101arrowz/fflate), which is MIT licensed. +- [PDF.js](https://github.com/mozilla/pdf.js), which is licensed under Apache License 2.0. ---
Happy reading with Readest!
[badge-website]: https://img.shields.io/badge/website-readest.com-orange +[badge-web-app]: https://img.shields.io/badge/read%20online-web.readest.com-orange [badge-license]: https://img.shields.io/github/license/chrox/readest?color=teal [badge-release]: https://img.shields.io/github/release/chrox/readest?color=green [badge-platforms]: https://img.shields.io/badge/OS-macOS%2C%20Windows%2C%20Linux%2C%20Web-green diff --git a/data/screenshots/annotations.jpeg b/data/screenshots/annotations.jpeg deleted file mode 100644 index 13117e94..00000000 Binary files a/data/screenshots/annotations.jpeg and /dev/null differ diff --git a/data/screenshots/annotations.png b/data/screenshots/annotations.png new file mode 100644 index 00000000..34567b20 Binary files /dev/null and b/data/screenshots/annotations.png differ diff --git a/data/screenshots/dark_mode.jpeg b/data/screenshots/dark_mode.jpeg deleted file mode 100644 index 296cabef..00000000 Binary files a/data/screenshots/dark_mode.jpeg and /dev/null differ diff --git a/data/screenshots/dark_mode.png b/data/screenshots/dark_mode.png new file mode 100644 index 00000000..be848f9c Binary files /dev/null and b/data/screenshots/dark_mode.png differ diff --git a/data/screenshots/deepl.jpeg b/data/screenshots/deepl.jpeg deleted file mode 100644 index 40dec8e7..00000000 Binary files a/data/screenshots/deepl.jpeg and /dev/null differ diff --git a/data/screenshots/deepl.png b/data/screenshots/deepl.png new file mode 100644 index 00000000..83c510b7 Binary files /dev/null and b/data/screenshots/deepl.png differ diff --git a/data/screenshots/footnote_popover.png b/data/screenshots/footnote_popover.png new file mode 100644 index 00000000..7bd915ad Binary files /dev/null and b/data/screenshots/footnote_popover.png differ diff --git a/data/screenshots/readest_landing_preview.png b/data/screenshots/landing_preview.png similarity index 100% rename from data/screenshots/readest_landing_preview.png rename to data/screenshots/landing_preview.png diff --git a/data/screenshots/wikipedia.jpeg b/data/screenshots/wikipedia.jpeg deleted file mode 100644 index b2fb6cd0..00000000 Binary files a/data/screenshots/wikipedia.jpeg and /dev/null differ diff --git a/data/screenshots/wikipedia.png b/data/screenshots/wikipedia.png new file mode 100644 index 00000000..9e82eaab Binary files /dev/null and b/data/screenshots/wikipedia.png differ