Skip to content

Commit 1b5e495

Browse files
committed
chore: Update readme
1 parent c1d8ea2 commit 1b5e495

File tree

3 files changed

+71
-1
lines changed

3 files changed

+71
-1
lines changed

CHANGELOG.md

+5
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
11

2+
3+
<a name="0.0.1"></a>
4+
# 0.0.1
5+
6+
Initial release. No features but also no bugs.

CONTRIBUTING.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributing
2+
3+
## Setup
4+
5+
You should have [node.js] and [npm] installed.
6+
7+
## Linting
8+
9+
Linting is done using [eslint] and the rules are based on [standard].
10+
11+
```bash
12+
$ npm run lint
13+
```
14+
15+
## Tests
16+
17+
Tests in node
18+
19+
```bash
20+
$ npm run test:node
21+
```
22+
23+
Tests in the browser
24+
25+
```bash
26+
$ npm run test:browser
27+
```
28+
29+
## Building browser version
30+
31+
```bash
32+
$ npm run build
33+
```
34+
35+
## Releases
36+
37+
The `release` task will
38+
39+
1. Run a build
40+
2. Commit the build
41+
3. Bump the version in `package.json`
42+
4. Commit the version change
43+
5. Create a git tag
44+
6. Run `git push` to `upstream/master` (You can change this with `--remote my-remote`)
45+
46+
```bash
47+
# Major release
48+
$ npm run release-major
49+
# Minor relase
50+
$ npm run release-minor
51+
# Patch release
52+
$ npm run release
53+
```
54+
55+
[node.js]: https://nodejs.org/
56+
[npm]: http://npmjs.org/
57+
[eslint]: http://eslint.org/
58+
[standard]: https://github.com/feross/standard

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
- [Use in a browser with browserify, webpack or any other bundler](#use-in-a-browser-with-browserify-webpack-or-any-other-bundler)
2424
- [Use in a browser Using a script tag](#use-in-a-browser-using-a-script-tag)
2525
- [Contribute](#contribute)
26+
- [Changelog](#changelog)
2627
- [License](#license)
2728

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

6061
## Contribute
6162

62-
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)!
63+
All are welcome, please join in!
6364

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

67+
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.
68+
6669
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
6770

71+
## Changelog
72+
73+
See [CHANGELOG.md](./CHANGELOG.md) for details of what has changed between releases.
74+
6875
## License
6976

7077
[MIT](LICENSE)

0 commit comments

Comments
 (0)