Skip to content
This repository was archived by the owner on May 26, 2023. It is now read-only.

Commit 9d5c64f

Browse files
author
Noel
authored
docs: packages (#413)
1 parent c9efd16 commit 9d5c64f

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

‎README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
[![codecov](https://codecov.io/gh/Zilliqa/Zilliqa-JavaScript-Library/branch/feature/monorepo/graph/badge.svg)](https://codecov.io/gh/Zilliqa/Zilliqa)
55
[![Discord Chat](https://img.shields.io/discord/308323056592486420.svg)](https://discord.gg/XMRE9tt)
66
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
7-
[![npm version](https://badge.fury.io/js/%40zilliqa-js%2Fzilliqa.svg)](https://badge.fury.io/js/%40zilliqa-js%2Fzilliqa)
87

98
## Introduction
109

@@ -19,16 +18,17 @@ other modules to function.
1918
The following table provides a description of each module and what you may
2019
want to use it for.
2120

22-
| package | description | dependencies |
23-
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
24-
| [`@zilliqa-js/core`](./packages/zilliqa-js-core) | Core abstractions and base classes, such as `HTTPProvider` and network logic for interfacing with the Zilliqa JSON-RPC. | none |
25-
| [`@zilliqa-js/account`](./packages/zilliqa-js-account) | `Wallet`, `Account` and `Transaction` abstractions live in this package. | `@zilliqa-js/core`, `@zilliqa-js/crypto`, `@zilliqa-js/util`, `@zilliqa-js/proto` |
26-
| [`@zilliqa-js/blockchain`](./packages/zilliqa-js-blockchain) | Main interface to the Zilliqa `JSON-RPC`. | none |
27-
| [`@zilliqa-js/contract`](./packages/zilliqa-js-contract) | Exposes a `Contracts` module that takes care of smart contract deployment and interaction. | `@zilliqa-js/account`, `@zilliqa-js/blockchain`, `@zilliqa-js/core`, `@zilliqa-js/util` |
28-
| [`@zilliqa-js/crypto`](./packages/zilliqa-js-crypto) | Exposes several loosely-coupled cryptographic convenience functions for working with the Zilliqa blockchain and its cryptographic primitives, such as Schnorr signatures. | `@zilliqa-js/util` |
29-
| [`@zilliqa-js/proto`](./packages/zilliqa-js-proto) | Protobuf source files and corresponding generated JS modules. | none |
30-
| [`@zilliqa-js/util`](./packages/zilliqa-js-util) | Miscellaneous functions that take care of serialisation/deserialisation and validation. | none |
31-
| [`@zilliqa-js/viewblock`](https://github.com/Ashlar/zilliqa-js-viewblock) | Library interfacing with ViewBlock's APIs | `@zilliqa-js/crypto` |
21+
| Package | Version | Description | Dependencies |
22+
| ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
23+
| [`@zilliqa-js/core`](./packages/zilliqa-js-core) | [![npm](https://img.shields.io/npm/v/@zilliqa-js/core.svg)](https://www.npmjs.com/package/zilliqa-js/core) | Core abstractions and base classes, such as `HTTPProvider` and network logic for interfacing with the Zilliqa JSON-RPC. | |
24+
| [`@zilliqa-js/util`](./packages/zilliqa-js-util) | [![npm](https://img.shields.io/npm/v/@zilliqa-js/util.svg)](https://www.npmjs.com/package/zilliqa-js/util) | Miscellaneous functions that take care of serialisation/deserialisation and validation. | |
25+
| [`@zilliqa-js/crypto`](./packages/zilliqa-js-crypto) | [![npm](https://img.shields.io/npm/v/@zilliqa-js/crypto.svg)](https://www.npmjs.com/package/zilliqa-js/crypto) | Exposes several loosely-coupled cryptographic convenience functions for working with the Zilliqa blockchain and its cryptographic primitives, such as Schnorr signatures. | `@zilliqa-js/util` |
26+
| [`@zilliqa-js/proto`](./packages/zilliqa-js-proto) | [![npm](https://img.shields.io/npm/v/@zilliqa-js/proto.svg)](https://www.npmjs.com/package/zilliqa-js/proto) | Protobuf source files and corresponding generated JS modules. | |
27+
| [`@zilliqa-js/account`](./packages/zilliqa-js-account) | [![npm](https://img.shields.io/npm/v/@zilliqa-js/account.svg)](https://www.npmjs.com/package/zilliqa-js/account) | `Wallet`, `Account` and `Transaction` abstractions. | `@zilliqa-js/core`, `@zilliqa-js/crypto`, `@zilliqa-js/proto` |
28+
| [`@zilliqa-js/blockchain`](./packages/zilliqa-js-blockchain) | [![npm](https://img.shields.io/npm/v/@zilliqa-js/blockchain.svg)](https://www.npmjs.com/package/zilliqa-js/blockchain) | Main interface to the Zilliqa `JSON-RPC`. | `@zilliqa-js/account` |
29+
| [`@zilliqa-js/contract`](./packages/zilliqa-js-contract) | [![npm](https://img.shields.io/npm/v/@zilliqa-js/contract.svg)](https://www.npmjs.com/package/zilliqa-js/contract) | Exposes a `Contracts` module that takes care of smart contract deployment and interaction. | `@zilliqa-js/blockchain` |
30+
| [`@zilliqa-js/subscriptions`](./packages/zilliqa-js-util) | [![npm](https://img.shields.io/npm/v/@zilliqa-js/subscriptions.svg)](https://www.npmjs.com/package/zilliqa-js/subscriptions) | Classes to interact with the websocket API of Zilliqa node. | |
31+
| [`@zilliqa-js/viewblock`](https://github.com/Ashlar/zilliqa-js-viewblock) | [![npm](https://img.shields.io/npm/v/@zilliqa-js/viewblock.svg)](https://www.npmjs.com/package/zilliqa-js/viewblock) | Library interfacing with ViewBlock's APIs. This package is maintained by [Ashlar](https://github.com/Ashlar) | `@zilliqa-js/crypto` |
3232

3333
## Pre-Requisite (Windows Users)
3434

0 commit comments

Comments
 (0)