aboutsummaryrefslogtreecommitdiff
path: root/api/readme.md
diff options
context:
space:
mode:
authorlonkaars <loek@pipeframe.xyz>2023-06-30 17:31:46 +0200
committerlonkaars <loek@pipeframe.xyz>2023-06-30 17:31:46 +0200
commit722127ef4059020876f708b1d5406c04fd07b0da (patch)
tree1a849e4c8eae688a9e51aaaaaff76d56ca79f171 /api/readme.md
parentcc5689eaf4f7cfa158e31107906434da9aed62bf (diff)
WIP user api
Diffstat (limited to 'api/readme.md')
-rw-r--r--api/readme.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/api/readme.md b/api/readme.md
new file mode 100644
index 0000000..58ebbcb
--- /dev/null
+++ b/api/readme.md
@@ -0,0 +1,6 @@
+# Yomikun API
+
+This folder contains an abstracted version of the [Core
+API](../core/readme.md), which is recommended for general use. Please see [the
+API examples](../examples/readme.md).
+