Browse Source

Add usage and installation to README

tags/v0.2.1^2^2
Bèr Kessels 2 years ago
parent
commit
3d7594b56a
1 changed files with 21 additions and 8 deletions
  1. 21
    8
      README.md

+ 21
- 8
README.md View File

@@ -2,20 +2,33 @@

PlaceBazaar tooling script to download a file and publish it to IPFS.

## Get going.
./wget-to-ipfs.sh
Option -u (--url) requires an argument

TODO: implement Makefile#install
-u --url [arg] URL to download. Required.
-r --root [arg] IPFS id of a directory to add the file to. Leave empty when you don't want to add the file to a directory.
-t --temp [arg] Location of tempfile. Default="/tmp/wget-to-ipfs"
-v Enable verbose mode, print script as it is executed
-d --debug Enables debug mode
-h --help This page
-n --no-color Disable color output

## Run it
Downloads a file from an URL and adds to IPFS.

TODO: implement Makefile#run
## Get going.

## Test it
Install wget and ipfs. Ensure both are runnable.

TODO: implement Makefile#test
Clone this repo:

## Components:
git clone https://git.webschuur.com/placebazaar/wget-to-ipfs.git

### Bash script
Run it:

cd wget-to-ipfs
./wget-to-ipfs.sh --url="http://berk.es/berkes_pub.gpg"

## Libraries used:
### Bash script
Uses [http://bash3boilerplate.sh/](http://bash3boilerplate.sh/).


Loading…
Cancel
Save