update readme

maorfr · maorfr · commit ee995e2171f2 · 2018-11-14T09:42:33.000+02:00
diff --git a/README.md b/README.md
@@ -1,26 +1,36 @@
+[![Release](https://img.shields.io/github/release/nuvo/skbn.svg)](https://github.com/nuvo/skbn/releases)
+[![Travis branch](https://img.shields.io/travis/nuvo/skbn/master.svg)](https://travis-ci.org/nuvo/skbn)
+[![Docker Pulls](https://img.shields.io/docker/pulls/nuvo/skbn.svg)](https://hub.docker.com/r/nuvo/skbn/)
+[![Go Report Card](https://goreportcard.com/badge/github.com/nuvo/skbn)](https://goreportcard.com/report/github.com/nuvo/skbn)
+[![license](https://img.shields.io/github/license/nuvo/skbn.svg)](https://github.com/nuvo/skbn/blob/master/LICENSE)
+
 # Skbn
 
 Skbn is a tool for copying files and directories between Kubernetes and cloud storage providers. It is named after the 1981 video game [Sokoban](https://en.wikipedia.org/wiki/Sokoban).
 Skbn currently supports the following providers:
 
 * AWS S3
+* Azure Blob Storage
 
 ## Install
 
-```
-wget -qO- https://github.com/nuvo/skbn/releases/download/0.1.1/skbn.tar.gz | sudo tar xvz -C /usr/local/bin
-```
+### Prerequisites
 
-## Build from source
+1. git
+2. [dep](https://github.com/golang/dep)
 
-Skbn uses [glide](https://github.com/Masterminds/glide) as a dependency management tool, since some of the referenced packages are not available using [dep](https://github.com/golang/dep).
+### From a release
+
+Download the latest release from the [Releases page](https://github.com/nuvo/skbn/releases) or use it with a [Docker image](https://hub.docker.com/r/nuvo/skbn)
+
+### From source
 
 ```
-glide up
-go build -o skbn cmd/skbn.go
+mkdir -p $GOPATH/src/github.com/nuvo && cd $_
+git clone https://github.com/nuvo/skbn.git && cd skbn
+make
 ```
 
-
 ## Usage
 
 ### Copy files from Kubernetes to S3
@@ -55,6 +65,60 @@ skbn cp \
     --dst k8s://<namespace>/<podName>/<containerName>/<path>
 ```
 
+## Parallel execution
+
+### Copy files from source to destination in parallel
+
+```
+skbn cp \
+    --src ... \
+    --dst ... \
+    --parallel <n>
+```
+* n is number of files to be copied in parallel (for full parallelism use 0)
+
+## Added bonus section
+
+### Copy files from S3 to Azure Blob Storage
+
+```
+skbn cp \
+    --src s3://<bucket>/<path> \
+    --dst abs://<account>/<container>/<path>
+```
+
+### Copy files from Azure Blob Storage to S3
+
+```
+skbn cp \
+    --src abs://<account>/<container>/<path> \
+    --dst s3://<bucket>/<path>
+```
+
+### Copy files from Kubernetes to Kubernetes
+
+```
+skbn cp \
+    --src k8s://<namespace>/<podName>/<containerName>/<path> \
+    --dst k8s://<namespace>/<podName>/<containerName>/<path>
+```
+
+### Copy files from S3 to S3
+
+```
+skbn cp \
+    --src s3://<bucket>/<path> \
+    --dst s3://<bucket>/<path>
+```
+
+### Copy files from Azure Blob Storage to Azure Blob Storage
+
+```
+skbn cp \
+    --src abs://<account>/<container>/<path> \
+    --dst abs://<account>/<container>/<path>
+```
+
 ## Credentials
 
 
@@ -72,9 +136,9 @@ Skbn uses the default AWS [credentials chain](https://docs.aws.amazon.com/sdk-fo
 
 ### Azure Blob Storage
 
-Skbn uses `AZURE_STORAGE_ACCOUNT` and `AZURE_STORAGE_ACCESS_KEY ` environment variables.
+Skbn uses `AZURE_STORAGE_ACCOUNT` and `AZURE_STORAGE_ACCESS_KEY` environment variables for authenication.
 
 ## Examples
 
-1. [In-cluster example](https://github.com/nuvo/skbn/tree/master/examples/in-cluster)
-2. [Code example](https://github.com/nuvo/skbn/tree/master/examples/code)
+1. [In-cluster example](/examples/in-cluster)
+2. [Code example](/examples/code)
