JavaScript implementation of IPFS' UnixFS (a representation of a Unix file system on top of a MerkleDAG)
The UnixFS spec can be found at ipfs/specs/UNIXFS.md
This project is broken into several modules, their purposes are:
/packages/ipfs-unixfsSerialization/deserialization of UnixFS objects to protocol buffers/packages/ipfs-unixfs-importerBuilds DAGs from files and directories/packages/ipfs-unixfs-exporterExports DAGs
- Clone this repo
- Run
npm install
This will install lerna and bootstrap the various packages, dedpuing and hoisting dependencies into the root folder.
If later you wish to remove all the node_modules/dist folders and start again, run npm reset && npm install from the root.
See the scripts section of the root package.json for more commands.
- Ensure you have a
GH_TOKENenv var containing a GitHub Personal Access Token withpublic_repopermissions - From the root of this repo run
npm run releaseand follow the on screen prompts. It will use conventional commits to work out the new package version
To publish a release candidate use npm run release:rc. This will result in version numbers similar to 0.4.4-rc.0+8d4b747 published under the npm tag next.
To update an rc, run npm run release:rc again.
Feel free to join in. All welcome. Open an issue!
This repository falls under the IPFS Code of Conduct.
