Update README
This commit is contained in:
parent
7cd569ee21
commit
43a2cdc949
22
README.md
22
README.md
|
@ -1,8 +1,24 @@
|
|||
# Kredits IPFS pinner
|
||||
# Kredits IPFS Pinner
|
||||
|
||||
This tool pins the IPFS hashes of a Kredits organisation on a IPFS node.
|
||||
This tool pins the IPFS hashes of a Kredits organisation on an IPFS node.
|
||||
|
||||
## Usage
|
||||
|
||||
$ kredits-ipfs-pinner --help
|
||||
### With NPX magic
|
||||
|
||||
npx @67p/kredits-ipfs-pinner
|
||||
|
||||
### Global install
|
||||
|
||||
npm install -g kredits-ipfs-pinner
|
||||
kredits-ipfs-pinner
|
||||
|
||||
### From repo
|
||||
|
||||
Clone the Git repository, then use npm scripts from its root directory.
|
||||
|
||||
npm start
|
||||
|
||||
Or with debug output:
|
||||
|
||||
npm run debug
|
||||
|
|
Loading…
Reference in New Issue