Adding README

This commit is contained in:
Alex Yatskov 2016-05-29 19:59:21 -07:00
parent b9d2bfbe12
commit c28ad13cb0

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# AnkiConnect #
The AnkiConnect plugin for [Anki](http://ankisrs.net/) provides a
[RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) interface for creating flash cards from
external applications. When installed, AnkiConnect will run a minimal
[Ajax](https://en.wikipedia.org/wiki/Ajax_(programming)) server on port 8765 when Anki is running; connecting clients,
such as the [Yomichan Extension for Chrome](https://foosoft.net/projects/yomichan-chrome-ext) can make use of the
exposed API extend Anki functionality.
## 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, you are all set; no
further configuration is required.