diff --git a/README.md b/README.md index c6639fbec9..cd2b70c212 100644 --- a/README.md +++ b/README.md @@ -28,19 +28,3 @@ The API is split up into a number of internal packages - Type definitions for interfaces as exposed by Polkadot & Substrate clients - - [@polkadot/types](packages/types/) Codecs for all Polkadot and Substrate primitives - -## development - -Contributions are welcome! - -To start off, this repo (along with others in the [@polkadot](https://github.com/polkadot-js/) family) uses yarn workspaces to organise the code. As such, after cloning, its dependencies _should_ be installed via `yarn`, not via npm; the latter will result in broken dependencies. - -To get started - - -1. Clone the repo locally, via `git clone https://github.com/polkadot-js/api ` -2. Ensure that you have a recent version of Node.js, for development purposes [Node 10](https://nodejs.org/en/) is recommended. -3. Ensure that you have a recent version of Yarn, for development purposes [Yarn >=1.10.1](https://yarnpkg.com/docs/install) is required. -4. Install the dependencies by running `yarn` -5. Build the everything via `yarn run build` -6. You can also launch the API Docs, via `yarn vuepress dev docs` -7. Access the docs via [http://localhost:8080](http://localhost:8080)