Update README

This commit is contained in:
Basti 2019-07-02 18:45:24 +02:00
parent 7cd569ee21
commit 43a2cdc949
No known key found for this signature in database
GPG Key ID: BE4634D632D39B67
1 changed files with 19 additions and 3 deletions

View File

@ -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