diff --git a/README.md b/README.md index bdfd06f2..3871e366 100644 --- a/README.md +++ b/README.md @@ -13,20 +13,20 @@ CosmJS is a library that consists of many smaller npm packages within the [@cosmjs namespace](https://www.npmjs.com/org/cosmjs), a so called monorepo. Here are some of them to get an idea: -| Package | Description | Latest version | -| ------------------------------------- | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------- | -| [@cosmjs/sdk38](packages/sdk38) | A client library for the Cosmos SDK 0.38 | [![npm version](https://img.shields.io/npm/v/@cosmjs/sdk38.svg)](https://www.npmjs.com/package/@cosmjs/sdk38) | -| [@cosmjs/faucet](packages/faucet) | A faucet application for node.js | [![npm version](https://img.shields.io/npm/v/@cosmjs/faucet.svg)](https://www.npmjs.com/package/@cosmjs/faucet) | -| [@cosmjs/cosmwasm](packages/cosmwasm) | Client for chains with the CosmWasm module enabled | [![npm version](https://img.shields.io/npm/v/@cosmjs/cosmwasm.svg)](https://www.npmjs.com/package/@cosmjs/cosmwasm) | -| [@cosmjs/crypto](packages/crypto) | Cryptography resources for blockchain projects | [![npm version](https://img.shields.io/npm/v/@cosmjs/crypto.svg)](https://www.npmjs.com/package/@cosmjs/crypto) | -| [@cosmjs/encoding](packages/encoding) | Encoding helpers for blockchain projects | [![npm version](https://img.shields.io/npm/v/@cosmjs/encoding.svg)](https://www.npmjs.com/package/@cosmjs/encoding) | -| [@cosmjs/math](packages/math) | Safe integers; decimals for handling financial amounts | [![npm version](https://img.shields.io/npm/v/@cosmjs/math.svg)](https://www.npmjs.com/package/@cosmjs/math) | +| Package | Description | Latest | +| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| [@cosmjs/sdk38](packages/sdk38) | A client library for the Cosmos SDK 0.38 | [![npm version](https://img.shields.io/npm/v/@cosmjs/sdk38.svg)](https://www.npmjs.com/package/@cosmjs/sdk38) | +| [@cosmjs/faucet](packages/faucet) | A faucet application for node.js | [![npm version](https://img.shields.io/npm/v/@cosmjs/faucet.svg)](https://www.npmjs.com/package/@cosmjs/faucet) | +| [@cosmjs/cosmwasm](packages/cosmwasm) | Client for chains with the CosmWasm module enabled | [![npm version](https://img.shields.io/npm/v/@cosmjs/cosmwasm.svg)](https://www.npmjs.com/package/@cosmjs/cosmwasm) | +| [@cosmjs/crypto](packages/crypto) | Cryptography for blockchain projects, e.g. hashing (SHA-2, Keccak256, Ripemd160), signing (secp256k1, ed25519), HD key derivation (BIPO39, SLIP-0010), KDFs and symmetric encryption for key storage (PBKDF2, Argon2, XChaCha20Poly1305) | [![npm version](https://img.shields.io/npm/v/@cosmjs/crypto.svg)](https://www.npmjs.com/package/@cosmjs/crypto) | +| [@cosmjs/encoding](packages/encoding) | Encoding helpers for blockchain projects | [![npm version](https://img.shields.io/npm/v/@cosmjs/encoding.svg)](https://www.npmjs.com/package/@cosmjs/encoding) | +| [@cosmjs/math](packages/math) | Safe integers; decimals for handling financial amounts | [![npm version](https://img.shields.io/npm/v/@cosmjs/math.svg)](https://www.npmjs.com/package/@cosmjs/math) | ### Modularity We're pretty proud of the modularity and a clean dependency tree in this monorepo. This ensures software quality on our side and lets users pick exactly -what they need. Here you see how everything fits together (every item is an npm +what they need. Here you see how everything fits together (every item is a npm package; right depends on left): ![CosmJS dependency tree](docs/cosmjs-tree.png) @@ -41,18 +41,19 @@ optipng cosmjs-tree.png ### Supported JS environments -Currently the codebase supports the following environments: +Currently the codebase supports the following runtime environments: 1. Node.js 10+ -2. Modern browsers (Chromium/Firefox/Safari, no IE or Edge) +2. Modern browsers (Chromium/Firefox/Safari, no Internet Explorer or + [Edge Spartan](https://en.wikipedia.org/wiki/Microsoft_Edge#Development)) 3. Browser extensions (Chromium/Firefox) Our current JavaScript target standard is ES2017, giving us native async/wait support. We use WebAssembly to implement certain crypto. We're happy to adjust this list according to users' needs as long as you don't -ask for IE support. If your environment does not support Wasm, we can work on a -solution with swapable implementations. +ask for Internet Explorer support. If your environment does not support Wasm, we +can work on a solution with swapable implementations. ## Development