From fba1a96119fdc6722501d7b8680652b5051e5c8a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Michael=20Mur=C3=A9?= <batolettre@gmail.com>
Date: Mon, 16 Aug 2021 18:00:36 +0200
Subject: [PATCH] add readme

---
 Readme.md | 13 +++++++++++++
 go.mod    |  2 +-
 2 files changed, 14 insertions(+), 1 deletion(-)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..de07801
--- /dev/null
+++ 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")
+```
\ No newline at end of file
diff --git a/go.mod b/go.mod
index 22b5116..bbe40e4 100644
--- a/go.mod
+++ b/go.mod
@@ -1,4 +1,4 @@
-module api-client
+module github.com/INFURA/ipfs-upload-client
 
 go 1.15