aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md28
1 files changed, 16 insertions, 12 deletions
diff --git a/README.md b/README.md
index 6b7ce5fc..18d70250 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,34 @@
# Yomichan for Chrome #
-The Yomichan extension for Chrome allows you to turn Chrome into a tool for building Japanese language literacy
-(regardless of current skill level), aiding in deciphering texts which would be otherwise too difficult tackle. This
-browser extension was inspired in part by [Rikaichan](https://addons.mozilla.org/en-US/firefox/addon/rikaichan/) and
+The Yomichan for Chrome extension turns your browser into a tool for building Japanese language literacy by helping you
+to decipher texts which would be otherwise too difficult tackle. This extension was inspired in part by
+[Rikaichan](https://addons.mozilla.org/en-US/firefox/addon/rikaichan/) and
[Rikaikun](https://chrome.google.com/webstore/detail/rikaikun/jipdnfibhldikgcjhfnomkfpcebammhp?hl=en), but it stands
apart in its goal of being a all-encompassing learning tool as opposed to a mere browser-based dictionary. It is the
-natural evolution of the [Yomichan](/projects/yomichan) plugin that I developed for [Anki](http://ankisrs.net/) back in
-2011 and the two applications can be used together in order to automatically generate flash cards for new vocabulary and
-Kanji encountered during reading.
+natural evolution of the [Yomichan](https://foosoft.net/projects/yomichan) plugin that I developed for
+[Anki](http://ankisrs.net/) when I was starting to learn Japanese back in 2011.
+
+<iframe width="800" height="500" src="https://www.youtube.com/embed/90_A1VpTnMk" frameborder="0" allowfullscreen></iframe>
## Installation ##
-The easiest way to install this extension is to download it from its listing in the [Chrome Web
+The most straightforward way to install this extension is to download it from its listing in the [Chrome Web
Store](https://chrome.google.com/webstore/detail/yomichan/ogmnaimimemjmbakcfefmnahgdfhfami). If you are a developer, you
can also clone the [repository on GitHub](https://github.com/FooSoft/yomichan-chrome-ext), provided that you have have
-installed [Git LFS](https://git-lfs.github.com/) and have initialized the included submodule dependencies after pulling
-down the main project. If you wish to use this extension alongside Anki, please read and follow the installation
-instructions for the [Yomichan](/projects/yomichan) plugin.
+[Git LFS](https://git-lfs.github.com/) installed (it is required to download the included dictionary files).
+
+If you wish to make use of the *AnkiConnect* functionality to create Japanese flash cards directly from your browser,
+you must install the [AnkiConnect](https://foosoft.net/projects/anki-connect) extension first. If you already have
+[Yomichan](https://foosoft.net/projects/yomichan) installed, AnkiConnect can be used after it is enabled in the plugin
+preferences.
## Usage ##
1. Click on the Yomichan browser action button in the upper right corner of the window (labeled ヨミ).
-2. Hold down the `Shift` or the middle mouse button while you move your mouse over Japanese text.
+2. Hold down the <kbd>Shift</kbd> or the middle mouse button while you move your mouse over Japanese text.
3. Resize the definition window by dragging the bottom right corner of the window.
4. Clicking on a Kanji will display the Kanji information page, including a Kanji stroke diagram.
-5. If you are using [AnkiConnect](/projects/yomichan), you will see buttons that can be used to create flash cards.
+5. Users of [AnkiConnect](https://foosoft.net/projects/anki-connect) will see buttons that can be used to create cards.
6. Right click on the Yomichan browser action button and select *Options* to configure the extension.
## Screenshots ##