Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

Commit

Permalink
docs: add development instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
haadcode authored and daviddias committed Oct 28, 2016
1 parent 66b2a7b commit 198a64a
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Consult the [Roadmap](/ROADMAP.md) for a complete state description of the proje
- [Usage](#usage)
- [Examples](#examples)
- [API](#api)
- [Development](#development)
- [Project structure](#project-structure)
- [IPFS Core implementation architecture](#ipfs-core-implementation-architecture)
- [IPFS Core](#ipfs-core)
Expand Down Expand Up @@ -118,6 +119,39 @@ The last published version of the package become [available for download](htt

A complete API definition will come, meanwhile, you can learn how to you use js-ipfs throught he standard interface at [![](https://img.shields.io/badge/interface--ipfs--core-API%20Docs-blue.svg)](https://github.com/ipfs/interface-ipfs-core)

## Development

### Clone
```
git clone https://github.com/ipfs/js-ipfs.git
cd js-ipfs
```

### Install Dependencies
```
npm install
```

### Run Tests
```
npm test
```

### Lint

*Conforming to linting rules is a prerequisite to commit to js-ipfs.*

```
npm run lint
```

### Build
```
npm run build
```

The ES5 distributable build will be located in `lib/`. The browser distributable will be located in `dist/index.js`.

## Project structure

```
Expand Down

0 comments on commit 198a64a

Please sign in to comment.