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

Updating README.md

Browse Source
This commit is contained in:
Alex Yatskov 2016-07-02 19:46:01 -07:00
parent c28ad13cb0
commit b192c8615e
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,15 +1,18 @@
# 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.
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.
## 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.
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.
## License ##
GPL