alex/anki-connect
1
Fork 0
Code Releases 5 Activity

Updating README.md

Browse Source
This commit is contained in:
Alex Yatskov 2016-07-04 20:24:53 -07:00
parent b192c8615e
commit 43dc04ba39
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,17 +1,19 @@
# AnkiConnect #
The AnkiConnect plugin for [Anki](http://ankisrs.net/) exposes a
[RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) API for creating flash cards from external
applications. When installed, AnkiConnect will host an [Ajax](https://en.wikipedia.org/wiki/Ajax_(programming)) server
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.
The AnkiConnect plugin enables external applications such as [Yomichan for Chrome](https://foosoft.net/projects/yomichan-chrome) to
communicate with Anki over a remote API. This makes it possible to execute queries against the user's card deck,
automatically create new vocabulary and Kanji flash cards, and more.
## Dependencies ##
* [Anki](http://ankisrs.net/)
## Installation ##
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
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 ##