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

Update README

Browse Source
This commit is contained in:
Alex Yatskov 2021-12-15 18:01:09 -08:00
parent 1d35bdbbc0
commit ed324caf16
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -7,7 +7,7 @@ Description = "Anki plugin to expose a remote API for creating flash cards."
Collection = "ProjectsActive" Collection = "ProjectsActive"
+++ --> +++ -->
# AnkiConnect # Anki-Connect
AnkiConnect enables external applications such as [Yomichan](https://foosoft.net/projects/yomichan/) to communicate with AnkiConnect enables external applications such as [Yomichan](https://foosoft.net/projects/yomichan/) to communicate with
[Anki](https://apps.ankiweb.net/) over a simple HTTP API. Its capabilities include executing queries against the user's [Anki](https://apps.ankiweb.net/) over a simple HTTP API. Its capabilities include executing queries against the user's
@ -32,7 +32,7 @@ Windows users may see a firewall nag dialog box appear on Anki startup. This occ
HTTP server in order to enable other applications to connect to it. The host application, Anki, must be unblocked for HTTP server in order to enable other applications to connect to it. The host application, Anki, must be unblocked for
this plugin to function correctly. this plugin to function correctly.
### Notes for macOS Users ### Notes for MacOS Users
Starting with [Mac OS X Mavericks](https://en.wikipedia.org/wiki/OS_X_Mavericks), a feature named *App Nap* has been Starting with [Mac OS X Mavericks](https://en.wikipedia.org/wiki/OS_X_Mavericks), a feature named *App Nap* has been
introduced to the operating system. This feature causes certain applications which are open (but not visible) to be introduced to the operating system. This feature causes certain applications which are open (but not visible) to be
@ -166,8 +166,8 @@ to make this happen. I recognise that the role of AnkiConnect has evolved from t
review new feature requests. review new feature requests.
With that said, *this project operates on a self-serve model*. If you would like a new feature, create a PR. I'll review With that said, *this project operates on a self-serve model*. If you would like a new feature, create a PR. I'll review
it and if it looks good, it will be merged in. *Requests to add new features without accompanying PRs will not be it and if it looks good, it will be merged in. *Requests to add new features without accompanying pull requests will not
serviced*. Make sure that your PRs meet the following criteria: be serviced*. Make sure that your pull request meets the following criteria:
* Attempt to match style of the surrounding code. * Attempt to match style of the surrounding code.
* Have accompanying documentation with examples. * Have accompanying documentation with examples.