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
Nim wrapper for the Matrix bot SDK.
45 commits 1 branch 0 tags 225 KiB
Nim 100%
Go to file
array-in-a-matrix b129fb0c60 proper readme
2023-12-14 16:54:11 -05:00
.vscode vscode recommended extensions for workplace 2023-12-09 18:31:52 -05:00
examples only import needed modules 2023-12-09 16:02:09 -05:00
nimbotsdk commented missing procs 2023-12-14 16:42:35 -05:00
.gitignore git ignore 2023-12-07 18:11:27 -05:00
LICENSE Initial commit 2023-12-03 17:41:40 -05:00
nimbotsdk.nim formatting 2023-12-14 16:42:20 -05:00
package.json node deps 2023-12-03 17:47:05 -05:00
pnpm-lock.yaml node deps 2023-12-03 17:47:05 -05:00
README.md proper readme 2023-12-14 16:54:11 -05:00

README.md

Nim Bot SDK

Nim wrapper for the 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.