aboutsummaryrefslogtreecommitdiff
path: root/examples/readme.md
blob: 707a0340443918f7ad3df4797989a51a1309d59c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# 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
- [x] Get furigana in HTML for a sentence
- [x] 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
- [ ] Choose alternate kanji reading for word