| author | Stephen Paul Weber
<singpolyma@singpolyma.net> 2026-05-27 04:55:21 UTC |
| committer | Stephen Paul Weber
<singpolyma@singpolyma.net> 2026-05-27 04:55:21 UTC |
| parent | 755fcdcb66480dc65edd312a316942a880c30106 |
| README.md | +3 | -3 |
| docs/js/index.md | +1 | -1 |
diff --git a/README.md b/README.md index 198f3d9..2c08657 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,11 @@ Working towards simplicity in developing Snikket-compatible apps. # JavaScript / TypeScript -`npm` subdirectory will contain installable package for browser or nodejs after build. +`npm` subdirectory will contain installable package for browser or nodejs after build, or simply: -Also Typescript typings are generated which include documenation comments. + npm i borogove - npm install https://gitpkg-singpolyma.vercel.app/snikket-im/snikket-sdk/npm?compiled +Also Typescript typings are generated which include documenation comments. 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 diff --git a/docs/js/index.md b/docs/js/index.md index e8664e5..f8abf75 100644 --- a/docs/js/index.md +++ b/docs/js/index.md @@ -3,7 +3,7 @@ This guide quickly brings you up to speed on Borogove's JavaScript API. The API is flexible and allows you to build any type of chat or messaging. ```console -npm i https://gitpkg-singpolyma.vercel.app/snikket-im/snikket-sdk/npm?compiled +npm i borogove ``` 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