From 2658aef200d74896c853042c0f26a8ae923a88e6 Mon Sep 17 00:00:00 2001 From: Amaury Martiny Date: Mon, 21 Jan 2019 12:17:39 +0100 Subject: [PATCH] Fix README links --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index bba6fa2c..dc91aef9 100644 --- a/README.md +++ b/README.md @@ -17,19 +17,19 @@ This repository is a monorepo that we manage using [Lerna](https://lernajs.io). That means that we publish [several packages](/packages) to npm from the same codebase. If you are a dapp developer, we recommend you start with the following three high-level packages: -| Package | Version | Docs | Description | -| ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| [`@parity/light.js`](/packages/light.js) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/light.js.svg)](https://www.npmjs.com/package/@parity/light.js) | [![docs](https://img.shields.io/badge/docs-passing-green.svg)](https://parity-js.github.io/light.js/) | A high-level reactive library optimized for light clients. | -| [`@parity/light.js-react`](/packages/light.js-react) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/light.js-react.svg)](https://www.npmjs.com/package/@parity/light.js-react) | [![README](https://img.shields.io/badge/docs-README-green.svg)](/packages/light.js-react#readme) | Easily integrate `@parity/light.js` with React. | -| [`@parity/api`](/packages/api) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/api.svg)](https://www.npmjs.com/package/@parity/api) | Coming soon... | Promise-based JSONRPC method wrapper, similar to [`web3.js`](https://github.com/ethereum/web3.js). | +| Package | Version | Docs | Description | +| ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| [`@parity/light.js`](https://github.com/paritytech/js-libs/tree/master/packages/light.js) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/light.js.svg)](https://www.npmjs.com/package/@parity/light.js) | [![docs](https://img.shields.io/badge/docs-passing-green.svg)](https://paritytech.github.io/js-libs/light.js/) | A high-level reactive library optimized for light clients. | +| [`@parity/light.js-react`](https://github.com/paritytech/js-libs/tree/master/packages/light.js-react) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/light.js-react.svg)](https://www.npmjs.com/package/@parity/light.js-react) | [![README](https://img.shields.io/badge/docs-README-green.svg)](https://github.com/paritytech/js-libs/tree/master/packages/light.js-react#readme) | Easily integrate `@parity/light.js` with React. | +| [`@parity/api`](https://github.com/paritytech/js-libs/tree/master/packages/api) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/api.svg)](https://www.npmjs.com/package/@parity/api) | Coming soon... | Promise-based JSONRPC method wrapper, similar to [`web3.js`](https://github.com/ethereum/web3.js). | And below are the lower-level packages, used internally, or by advanced users. -| Package | Version | Docs | Description | -| ------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | -| [`@parity/abi`](/packages/abi) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/abi.svg)](https://www.npmjs.com/package/@parity/abi) | [![docs](https://img.shields.io/badge/docs-passing-green.svg)](https://parity-js.github.io/abi/) | Ethereum ABI encoder and decoder. | -| [`@parity/contracts`](/packages/contracts) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/contracts.svg)](https://www.npmjs.com/package/@parity/contracts) | [![README](https://img.shields.io/badge/docs-README-green.svg)](/packages/contracts#readme) | Parity's [contracts](https://github.com/parity-contracts) as ES6 classes. | -| [`@parity/electron`](/packages/electron) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/electron.svg)](https://www.npmjs.com/package/@parity/electron) | [![README](https://img.shields.io/badge/docs-README-green.svg)](/packages/electron#readme) | Control the Parity Ethereum node from Electron. | +| Package | Version | Docs | Description | +| ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| [`@parity/abi`](https://github.com/paritytech/js-libs/tree/master/packages/abi) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/abi.svg)](https://www.npmjs.com/package/@parity/abi) | [![docs](https://img.shields.io/badge/docs-passing-green.svg)](https://paritytech.github.io/js-libs/abi/) | Ethereum ABI encoder and decoder. | +| [`@parity/contracts`](https://github.com/paritytech/js-libs/tree/master/packages/contracts) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/contracts.svg)](https://www.npmjs.com/package/@parity/contracts) | [![README](https://img.shields.io/badge/docs-README-green.svg)](https://github.com/paritytech/js-libs/tree/master/packages/contracts#readme) | Parity's [contracts](https://github.com/parity-contracts) as ES6 classes. | +| [`@parity/electron`](https://github.com/paritytech/js-libs/tree/master/packages/electron) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/electron.svg)](https://www.npmjs.com/package/@parity/electron) | [![README](https://img.shields.io/badge/docs-README-green.svg)](https://github.com/paritytech/js-libs/tree/master/packages/electron#readme) | Control the Parity Ethereum node from Electron. | ### Contributing @@ -58,6 +58,7 @@ yarn build 1. Fork the repo 2. Clone your fork + ```bash git clone https://github.com//js-libs ``` @@ -93,7 +94,6 @@ yarn test; yarn lint; yarn build 8. Create a pull request from your fork of the repo to the upstream master branch - ## License All Parity's JavaScript libraries are open-source software [licensed as MIT](/LICENSE).