From 43dc04ba39ae903015a23d13a3c8b636fd8fe2c1 Mon Sep 17 00:00:00 2001 From: Alex Yatskov Date: Mon, 4 Jul 2016 20:24:53 -0700 Subject: [PATCH] Updating README.md --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a712caa..34467c4 100644 --- a/README.md +++ b/README.md @@ -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 ##