|
1 | | -# js-ipfs-unixfs <!-- omit in toc --> |
2 | | - |
3 | 1 | [](https://ipfs.tech) |
4 | 2 | [](https://discuss.ipfs.tech) |
5 | 3 | [](https://codecov.io/gh/ipfs/js-ipfs-unixfs) |
6 | 4 | [](https://github.com/ipfs/js-ipfs-unixfs/actions/workflows/js-test-and-release.yml?query=branch%3Amaster) |
7 | 5 |
|
8 | 6 | > JS implementation of the IPFS UnixFS |
9 | 7 |
|
10 | | -## Table of contents <!-- omit in toc --> |
11 | | - |
12 | | -- [Structure](#structure) |
13 | | -- [Lead Maintainer <!-- omit in toc -->](#lead-maintainer----omit-in-toc---) |
14 | | -- [Development](#development) |
15 | | - - [Publishing new versions](#publishing-new-versions) |
16 | | - - [Using prerelease versions](#using-prerelease-versions) |
17 | | -- [API Docs](#api-docs) |
18 | | -- [License](#license) |
19 | | -- [Contribute](#contribute) |
| 8 | +The UnixFS spec can be found at [ipfs/specs/UNIXFS.md](https://github.com/ipfs/specs/blob/master/UNIXFS.md) |
20 | 9 |
|
21 | | -## Structure |
| 10 | +# Packages |
22 | 11 |
|
23 | 12 | - [`/packages/ipfs-unixfs`](./packages/ipfs-unixfs) JavaScript implementation of IPFS' unixfs (a Unix FileSystem representation on top of a MerkleDAG) |
24 | 13 | - [`/packages/ipfs-unixfs-exporter`](./packages/ipfs-unixfs-exporter) JavaScript implementation of the UnixFs exporter used by IPFS |
25 | 14 | - [`/packages/ipfs-unixfs-importer`](./packages/ipfs-unixfs-importer) JavaScript implementation of the UnixFs importer used by IPFS |
26 | 15 |
|
27 | | -The UnixFS spec can be found at [ipfs/specs/UNIXFS.md](https://github.com/ipfs/specs/blob/master/UNIXFS.md) |
28 | | - |
29 | | -## Lead Maintainer <!-- omit in toc --> |
30 | | - |
31 | | -[Alex Potsides](https://github.com/achingbrain) |
32 | | - |
33 | | -- [`/packages/ipfs-unixfs`](./packages/ipfs-unixfs) Serialization/deserialization of UnixFS objects to protocol buffers |
34 | | -- [`/packages/ipfs-unixfs-importer`](./packages/ipfs-unixfs-importer) Builds DAGs from files and directories |
35 | | -- [`/packages/ipfs-unixfs-exporter`](./packages/ipfs-unixfs-exporter) Exports DAGs |
36 | | - |
37 | | -## Development |
38 | | - |
39 | | -1. Clone this repo |
40 | | -2. Run `npm install` |
41 | | - |
42 | | -This will install [lerna](https://www.npmjs.com/package/lerna) and bootstrap the various packages, dedpuing and hoisting dependencies into the root folder. |
43 | | - |
44 | | -If later you wish to remove all the `node_modules`/`dist` folders and start again, run `npm run reset && npm install` from the root. |
45 | | - |
46 | | -See the scripts section of the root [`package.json`](./package.json) for more commands. |
47 | | - |
48 | | -### Publishing new versions |
49 | | - |
50 | | -1. Ensure you have a `GH_TOKEN` env var containing a GitHub [Personal Access Token](https://github.com/settings/tokens) with `public_repo` permissions |
51 | | -2. From the root of this repo run `npm run release` and follow the on screen prompts. It will use [conventional commits](https://www.conventionalcommits.org) to work out the new package version |
52 | | - |
53 | | -### Using prerelease versions |
54 | | - |
55 | | -Any changed packages from each successful build of master are published to npm as canary builds under the npm tag `next`. |
56 | | - |
57 | | -Canary builds only consider changes to packages in the last built commit so changes to the root config files should not result in new prereleases being published to npm. |
58 | | - |
59 | | -## API Docs |
| 16 | +# API Docs |
60 | 17 |
|
61 | 18 | - <https://ipfs.github.io/js-ipfs-unixfs> |
62 | 19 |
|
63 | | -## License |
| 20 | +# License |
64 | 21 |
|
65 | 22 | Licensed under either of |
66 | 23 |
|
67 | 24 | - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>) |
68 | 25 | - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>) |
69 | 26 |
|
70 | | -## Contribute |
| 27 | +# Contribute |
71 | 28 |
|
72 | 29 | Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-ipfs-unixfs/issues). |
73 | 30 |
|
|
0 commit comments