diff options
| author | lonkaars <loek@pipeframe.xyz> | 2023-06-29 23:25:01 +0200 |
|---|---|---|
| committer | lonkaars <loek@pipeframe.xyz> | 2023-06-29 23:25:01 +0200 |
| commit | cc5689eaf4f7cfa158e31107906434da9aed62bf (patch) | |
| tree | f02bb5f0887a48de32b9b06b6500c158043f0c52 /examples/readme.md | |
| parent | ccd4760cc28082c2d7d9bbebd1a60fe7da65d121 (diff) | |
WIP examples + change `.prepare()` to `await .ready`
Diffstat (limited to 'examples/readme.md')
| -rw-r--r-- | examples/readme.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/examples/readme.md b/examples/readme.md new file mode 100644 index 0000000..9eb8760 --- /dev/null +++ b/examples/readme.md @@ -0,0 +1,17 @@ +# API Examples + +## **ALL OF THESE EXAMPLES ARE CURRENTLY NOT WORKING, AND ARE USED TO MODEL THE API UNTIL THEY WORK** + +~This folder contains API examples. These files show some common workflows +using the Yomikun API.~ + +Examples (checked = working): + +- [ ] Lookup a word in a sentence +- [ ] Get furigana in HTML for a sentence +- [ ] Correct the reading of a word (because of ambiguous word boundries) by inserting a break +- [ ] Login as a regular user and ignore an expression +- [ ] Login as root and import a dictionary from a local file +- [ ] Series-specific search with a lot of jargon +- [ ] Lookup kanji details of a word + |