aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDarius Jahandarie <djahandarie@gmail.com>2023-08-19 18:29:13 +0900
committerDarius Jahandarie <djahandarie@gmail.com>2023-08-20 10:24:43 +0900
commit51f0f0c4d1828a4cf715269feeae879fe610f204 (patch)
treee148e4409174561f97b034e9a11166ac5ac8f4d7 /README.md
parentbfe6c06c486d6fb522d252cb4660eb9f496428cc (diff)
Update README.md
Include badges, update links to releases, and extra verbiage about state of the project.
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 16 insertions, 11 deletions
diff --git a/README.md b/README.md
index 3f8b7a91..a299368c 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,18 @@
# Yomitan
+[![Chrome Release (Testing)](https://img.shields.io/chrome-web-store/v/likgccmbimhjbgkjambclfkhldnlhbnn?label=chrome%20release%20(testing))](https://chrome.google.com/webstore/detail/yomitan-development-build/glnaenfapkkecknnmginabpmgkenenml)
+[![Firefox Release (Testing)](https://img.shields.io/github/v/release/themoeway/yomitan?filter=*&label=firefox%20release%20(testing))](https://github.com/themoeway/yomitan/releases)
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/themoeway/yomitan/badge)](https://securityscorecards.dev/viewer/?uri=github.com/themoeway/yomitan)
+[![Discord Server](https://dcbadge.vercel.app/api/server/4ysT8qjE?style=flat)](https://discord.gg/4ysT8qjE)\
+**Important note:** Yomitan is still not recommended for use, as we are still trying to complete the transition to Manifest V3 (which is required of all new browser extensions), and there are [some critical bugs remaining](https://github.com/themoeway/yomitan/issues?q=is%3Aopen+is%3Aissue+label%3Apriority%2Fhigh). This is also why there is no stable release of yomitan yet.
+
> :wave: **This project is a community fork of yomichan** (which was [sunset](https://foosoft.net/posts/sunsetting-the-yomichan-project/) by its owner on Feb 26 2023).
>
> The primary goal is to **keep the project alive and working on latest browser versions and doing bugfixes**. (Feature improvements are considered secondary.)
>
> Since the owner requested forks be uniquely named, we have chosen a new name: *yomitan*. (*-tan* is an honorific used for anthropomorphic moe characters.) While we've renamed the codebase and made judicious use of find-and-replace, it is entirely the hard work of foosoft and numerous other open source contributors from 2016-2023 and we do not claim any credit.
>
-> Since this is a distributed effort, we highly welcome new contributors! Feel free to browse the issue tracker, and you can find us on [TheMoeWay Discord](https://discord.gg/nhqjydaR8j) at [#colab-tmw-projects](https://discord.com/channels/617136488840429598/1081538711742844980)
+> Since this is a distributed effort, we highly welcome new contributors! Feel free to browse the issue tracker, and you can find us on [TheMoeWay Discord](https://discord.gg/4ysT8qjE) at [#colab-tmw-projects](https://discord.com/channels/617136488840429598/1081538711742844980)
Yomitan turns your web browser into a tool for building Japanese language literacy by helping you to decipher texts
@@ -54,18 +60,17 @@ New changes are initially introduced into the *testing* version, and after some
relatively bug free, they will be promoted to the *stable* version. If you are technically savvy and don't mind
submitting issues on GitHub, try the *testing* version; otherwise, the *stable* version will be your best bet.
-> :warning: These releases haven't been updated and still link to yomichan.
+* **Google Chrome**
+ * stable (not released yet)
+ * [testing](https://chrome.google.com/webstore/detail/yomitan-development-build/glnaenfapkkecknnmginabpmgkenenml)
-* **Google Chrome**
- ([stable](https://chrome.google.com/webstore/detail/yomichan/ogmnaimimemjmbakcfefmnahgdfhfami) or [testing](https://chrome.google.com/webstore/detail/yomichan-testing/bcknnfebhefllbjhagijobjklocakpdm)) \
- [![](img/chrome-web-store.png)](https://chrome.google.com/webstore/detail/yomichan/ogmnaimimemjmbakcfefmnahgdfhfami)
+* **Mozilla Firefox**
+ * stable (not released yet)
+ * [testing](https://github.com/themoeway/yomitan/releases) ※
-* **Mozilla Firefox**
- ([stable](https://addons.mozilla.org/en-US/firefox/addon/yomichan/) or [testing](https://github.com/FooSoft/yomichan/releases)<sup>*</sup>) \
- [![](img/firefox-marketplace.png)](https://addons.mozilla.org/en-US/firefox/addon/yomichan/) \
- <sup>*</sup>Unlike Chrome, Firefox does not allow extensions meant for testing to be hosted in the marketplace.
- You will have to download a desired version and side-load it yourself. You only need to do this once and will get
- updates automatically.
+※ NOTE: Unlike Chrome, Firefox does not allow extensions meant for testing to be hosted in the marketplace.
+You will have to download a desired version and side-load it yourself. You only need to do this once and will get
+updates automatically.
## Migrating from Yomichan