Updating README.md
This commit is contained in:
parent
b192c8615e
commit
43dc04ba39
14
README.md
14
README.md
@ -1,17 +1,19 @@
|
|||||||
# AnkiConnect #
|
# AnkiConnect #
|
||||||
|
|
||||||
The AnkiConnect plugin for [Anki](http://ankisrs.net/) exposes a
|
The AnkiConnect plugin enables external applications such as [Yomichan for Chrome](https://foosoft.net/projects/yomichan-chrome) to
|
||||||
[RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) API for creating flash cards from external
|
communicate with Anki over a remote API. This makes it possible to execute queries against the user's card deck,
|
||||||
applications. When installed, AnkiConnect will host an [Ajax](https://en.wikipedia.org/wiki/Ajax_(programming)) server
|
automatically create new vocabulary and Kanji flash cards, and more.
|
||||||
on port 8765 for as long as Anki is running; connecting clients, such as [Yomichan for
|
|
||||||
Chrome](https://foosoft.net/projects/yomichan-chrome) can make use of this interface to extend Anki functionality.
|
|
||||||
|
|
||||||
|
## Dependencies ##
|
||||||
|
|
||||||
|
* [Anki](http://ankisrs.net/)
|
||||||
|
|
||||||
## Installation ##
|
## Installation ##
|
||||||
|
|
||||||
AnkiConnect can be downloaded from its [Anki shared addon page](https://ankiweb.net/shared/info/2055492159) or enabled
|
AnkiConnect can be downloaded from its [Anki shared addon page](https://ankiweb.net/shared/info/2055492159) or enabled
|
||||||
through the [Yomichan](https://foosoft.net/projects/yomichan) plugin if you have it installed. Once AnkiConnect is installed it is ready
|
through the [Yomichan](https://foosoft.net/projects/yomichan) plugin if you have it installed. Once AnkiConnect is installed it is ready
|
||||||
for use; no further configuration is required.
|
for use; no further configuration is required. Windows users may have to take additional steps to make Windows Firewall
|
||||||
|
allows AnkiConnect to listen for incoming connections on TCP port 8765.
|
||||||
|
|
||||||
## License ##
|
## License ##
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user