diff options
Diffstat (limited to 'core/readme.md')
| -rw-r--r-- | core/readme.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/core/readme.md b/core/readme.md new file mode 100644 index 0000000..3c602a9 --- /dev/null +++ b/core/readme.md @@ -0,0 +1,12 @@ +# Core API + +This folder contains the Core API. A Core instance is used as a standardized +API for interfacing with internal classes/modules. Different Cores can be used +interchangeably with the [Yomikun API](../api/readme.md) for providing the API +over various types of connections. + +Currently implemented cores: + +- HTTP +- Direct + |