@withautonomi/autonomi 0.4.3 → 0.5.0

package/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 edition = "2021"
 name = "autonomi-nodejs"
-version = "0.1.0"
+version = "0.1.1"
 description = "NodeJS bindings for the autonomi client"
 license = "GPL-3.0"
 
@@ -9,7 +9,7 @@ license = "GPL-3.0"
 crate-type = ["cdylib"]
 
 [dependencies]
-autonomi = { path = "../autonomi" }
+autonomi = { path = "../autonomi", version = "0.5.0" }
 bytes = { version = "1.0.1", features = ["serde"] }
 eyre = "0.6.12"
 futures = "0.3"

package/README.md

@@ -0,0 +1,76 @@
+The client API for Autonomi. This Node.js addon provides bindings into the Rust `autonomi` crate.
+
+# Usage
+
+Add the `@withautonomi/autonomi` package to your project. For example, using `npm`:
+```console
+$ npm install @withautonomi/autonomi
+```
+
+Using a modern version of Node.js we can use `import` and `async` easily when we use the `.mjs` extension. Import the `Client` and you're ready to connect to the network!
+
+```js
+// main.mjs
+import { Client } from '@withautonomi/autonomi'
+const client = await Client.initLocal()
+```
+
+Run the script:
+
+```console
+$ node main.js
+```
+
+## Examples
+
+> Work in progress:
+> 
+> For general guides and usage, see the [Developer Documentation](https://docs.autonomi.com/developers). This is currently worked on specifically to include Node.js usage.
+
+For example usage, see the [`__test__`](./__test__) directory. Replace `import { .. } from '../index.js'` to import from `@withautonomi/autonomi` instead.
+
+# Contributing, compilation and publishing
+
+To contribute or develop on the source code directly, we need a few requirements.
+
+- Yarn
+  - `npm install --global yarn`
+- We need the NAPI RS CLI tool
+  - `yarn global add @napi-rs/cli`
+
+Install the dependencies for the project:
+```console
+$ yarn install
+```
+
+## Build
+
+Then build using the `napi` CLI:
+```console
+$ npx napi build
+```
+
+## Running tests
+
+Run the `test` script:
+
+```console
+yarn test
+# Or run a specific test
+yarn test __test__/register.spec.mjs -m 'registers errors'
+```
+
+## Publishing
+
+Before publishing, bump the versions of *all* packages with the following:
+```console
+$ npm version patch --no-git-tag-version
+```
+
+Use `major` or `minor` instead of `patch` depending on the release.
+
+It's a good practice to have an unreleased version number ready to go. So if `0.4.0` is the version released on NPM currently, `package.json` should be at `0.4.1`.
+
+### Workflow
+
+Use the 'JS publish to NPM' workflow (`nodejs-publish.yml`) to publish the package from `main` or a tag. This workflow has to be manually dispatched through GitHub.