diff --git a/README.md b/README.md index 6a0aefc1..2516bb7b 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,12 @@ -# Holochain Client - JavaScript - [![Project](https://img.shields.io/badge/Project-Holochain-blue.svg?style=flat-square)](http://holochain.org/) [![Forum](https://img.shields.io/badge/Forum-forum%2eholochain%2enet-blue.svg?style=flat-square)](https://forum.holochain.org) [![License: CAL 1.0](https://img.shields.io/badge/License-CAL%201.0-blue.svg)](https://github.com/holochain/cryptographic-autonomy-license) ![Test](https://github.com/holochain/holochain-client-js/actions/workflows/test.yml/badge.svg?branch=main) - [![Twitter Follow](https://img.shields.io/twitter/follow/holochain.svg?style=social&label=Follow)](https://twitter.com/holochain) -A JavaScript client for the Holochain Conductor API (works with browsers as well as Nodejs) +# Holochain Client - JavaScript + +A JavaScript client for the Holochain Conductor API (works with browsers as well as Nodejs). > Holochain's Conductor API is under active development. This client package tracks that development fairly closely but sometimes gets behind. @@ -57,11 +56,10 @@ See [docs/API.md](docs/API.md) # Holochain Compatibility -This version of `@holochain/client` is currently working with -- `holochain/holochain` at tag [holochain-0.0.122](https://github.com/holochain/holochain/tree/holochain-0.0.122) -- hdk version [0.0.118 from crates.io](https://crates.io/crates/hdk/0.0.118) +See [default.nix](./default.nix) for the Holochain version this package is compatible with. -If updating this code, please make changes to the git `rev/sha` above. (You can get this from `hn-introspect` after updating the holonix-hash) +If updating the Holochain version included in holonix, please use `niv update` as explained in the +[Holochain Installation Guide](https://developer.holochain.org/install/#upgrading-the-holochain-version). ## Running tests @@ -76,14 +74,16 @@ nix-shell ``` ## Contribute + Holochain is an open source project. We welcome all sorts of participation and are actively working on increasing surface area to accept it. Please see our [contribution guidelines](/CONTRIBUTING.md) for our general practices and protocols on participating in the community, as well as specific expectations around things like code formatting, testing practices, continuous integration, etc. * Connect with us on our [forum](https://forum.holochain.org) ## License + [![License: CAL 1.0](https://img.shields.io/badge/License-CAL%201.0-blue.svg)](https://github.com/holochain/cryptographic-autonomy-license) -Copyright (C) 2020-2021, Holochain Foundation +Copyright (C) 2020-2022, Holochain Foundation This program is free software: you can redistribute it and/or modify it under the terms of the license provided in the LICENSE file (CAL-1.0). This program is distributed in the hope that it will be useful, diff --git a/package.json b/package.json index 43cc4b78..6f8ec22c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@holochain/client", - "version": "0.3.3", + "version": "0.3.4", "description": "A JavaScript client for the Holochain Conductor API", "author": "Holochain Foundation (http://holochain.org)", "license": "CAL-1.0", @@ -18,7 +18,7 @@ }, "homepage": "https://github.com/holochain/holochain-client-js#readme", "engines": { - "node": "^14.13.1 || >=16.0.0" + "node": "^14.13.1 || >=16.0.0 || >=18.0.0" }, "type": "module", "exports": {