| author | Stephen Paul Weber
<singpolyma@singpolyma.net> 2026-05-27 15:47:16 UTC |
| committer | Stephen Paul Weber
<singpolyma@singpolyma.net> 2026-05-27 15:47:16 UTC |
| parent | b40d3f5ab779411dccdd469772477f960f2b93c0 |
| README.md | +16 | -31 |
diff --git a/README.md b/README.md index 2c08657..400ff2d 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,46 @@ # [Borogove](https://borogove.dev) -Working towards simplicity in developing Snikket-compatible apps. +Borogove is a high-level headless chat SDK for building chat apps or chat experiences into other apps, backed by any [Snikket](https://snikket.org)-compatible server. + +## Building Everything make hx-build-dep make -# JavaScript / TypeScript +## Running Tests -`npm` subdirectory will contain installable package for browser or nodejs after build, or simply: + make test - npm i borogove +or, for a more comprehensive and slower set of tests: -Also Typescript typings are generated which include documenation comments. + make ci -There is a known bug in one of our JavaScript dependencies for browser builds, if xmpp.js is <= 0.14.0 then you may need something like this vite.config.js example +## JavaScript / TypeScript -```js -resolve: { - alias: { - // https://github.com/xmppjs/xmpp.js/issues/1093 - "node:dns": "./src/dns-stub.js", - }, -}, -``` +`npm` subdirectory will contain installable package for browser or nodejs after build, or simply: -And then the stub: + npm i borogove -```js -export default { - lookup: (x, y, cb) => cb(null, []), - resolveSrv: (x, cb) => cb(null, []), -}; -``` +Typescript typings are generated which include documenation comments. -# C +## C `libborogove.so` and `cpp/borogove.h`, the latter has documentation comments. Alternately there is also `libborogove.batteriesincluded.so` which vendors some dependencies. Or `libborogove.a` which is a static library. -If you want to build on a system that does not have haxe: +If you want to build on a system that does not have Haxe: make cpp The the `cpp` folder will contain C++ code and a Makefile with no haxe dependency. -[Alpine package](https://pkgs.alpinelinux.org/package/edge/community/x86/borogove-sdk) - -# Swift +## Swift `libborogove.so` and `cpp/borogove.h` are wrapped by `cpp/Borogove.swift` See also the [SwiftPM Package](https://borogove.dev/src/r/swiftpm/). -# Used By Apps Such As +## Documentation -* [Cheogram WWW](https://git.singpolyma.net/cheogram-www) -* [Cheogram CLI Dialler](https://git.singpolyma.net/ccd) -* [Cheogram iOS](https://git.singpolyma.net/cheogram-aapl) -* [Honeybee](https://sr.ht/~anjan/honeybee/) +https://borogove.dev/docs/