add readme

INFURA · Aug 16, 2021 · fba1a96 · fba1a96
1 parent d3fd9bc
commit fba1a96
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/Readme.md b/Readme.md
@@ -0,0 +1,13 @@
+`ipfs-upload-client` is a minimal CLI tool to upload files or directories to Infura's IPFS or another API endpoint.
+
+## Example
+
+`ipfs-upload-client --id xxxxx --secret yyyyy /path/to/data`
+
+## Options
+```
+  --id string       your Infura ProjectID
+  --pin             whether or not to pin the data (default true)
+  --secret string   your Infura ProjectSecret
+  --url string      the API URL (default "https://ipfs.infura.io:5001")
+```
diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module api-client
+module github.com/INFURA/ipfs-upload-client
 
 go 1.15