array-in-a-matrix/nimbotsdk
1
0
Fork 0
generated from array-in-a-matrix/matrix-bot-template
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

proper readme

Browse source
This commit is contained in:
array-in-a-matrix 2023-12-14 16:54:11 -05:00
parent 4a8e34792d
commit b129fb0c60
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -2,4 +2,18 @@
Nim wrapper for the [Matrix bot SDK](https://github.com/turt2live/matrix-bot-sdk).
## Setup
Run `pnpm add matrix-bot-sdk` after cloning template.
## Usage
To import the entire library, your Nim program only needs to import the `nimbotsdk.nim` from the root of the repository. To import a specific module you need to import `matrixTypes.nim` and the needed module(s) from `nimbotsdk/`.
There are code examples inside the `examples/` directory.
## Development
Nim files inside `nimbotsdk/` are named after the file they wrap (`MatrixAuth.nim` is a wrapper to `MatrixAuth.d.ts`). `matrixTypes.nim` defines the object types used throughout the entire library.
Procedures that have been tested to work are imported into `nimbotsdk.nim` in the root of the project.