Skip to content
This repository has been archived by the owner on Mar 10, 2020. It is now read-only.

Commit

Permalink
chore: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
achingbrain committed Apr 11, 2018
1 parent c1d8ea2 commit 1b5e495
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 1 deletion.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@


<a name="0.0.1"></a>
# 0.0.1

Initial release. No features but also no bugs.
58 changes: 58 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Contributing

## Setup

You should have [node.js] and [npm] installed.

## Linting

Linting is done using [eslint] and the rules are based on [standard].

```bash
$ npm run lint
```

## Tests

Tests in node

```bash
$ npm run test:node
```

Tests in the browser

```bash
$ npm run test:browser
```

## Building browser version

```bash
$ npm run build
```

## Releases

The `release` task will

1. Run a build
2. Commit the build
3. Bump the version in `package.json`
4. Commit the version change
5. Create a git tag
6. Run `git push` to `upstream/master` (You can change this with `--remote my-remote`)

```bash
# Major release
$ npm run release-major
# Minor relase
$ npm run release-minor
# Patch release
$ npm run release
```

[node.js]: https://nodejs.org/
[npm]: http://npmjs.org/
[eslint]: http://eslint.org/
[standard]: https://github.com/feross/standard
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
- [Use in a browser with browserify, webpack or any other bundler](#use-in-a-browser-with-browserify-webpack-or-any-other-bundler)
- [Use in a browser Using a script tag](#use-in-a-browser-using-a-script-tag)
- [Contribute](#contribute)
- [Changelog](#changelog)
- [License](#license)

## Install
Expand Down Expand Up @@ -59,12 +60,18 @@ Loading this module through a script tag will make the `mfs` obj available in th

## Contribute

All are welcome, please join in! Open an [issue](https://github.com/ipfs/js-ipfs-mfs/issues) or send a [PR](https://github.com/ipfs/js-ipfs-mfs/pulls)!
All are welcome, please join in!

This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).

Open an [issue](https://github.com/ipfs/js-ipfs-mfs/issues) or send a [PR](https://github.com/ipfs/js-ipfs-mfs/pulls) - see [CONTRIBUTING.md](./CONTRIBUTING.md) for how to make sure your branch is ready for PRing.

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)

## Changelog

See [CHANGELOG.md](./CHANGELOG.md) for details of what has changed between releases.

## License

[MIT](LICENSE)

0 comments on commit 1b5e495

Please sign in to comment.