update readme.md

README.md

@@ -12,20 +12,21 @@ Kafka CLI
 1. [Kafka 0.9.0.* or latest releases](http://kafka.apache.org/downloads.html)
 2. [Confluent 3.0.* or latest releases](https://www.confluent.io/download/)
 
-## Kafka Connect CLI
+## How to build project ?
 
-A simple Command line interface (CLI) to manage connectors through the Kafka Connect REST Interface.
+[Go Lang](https://golang.org/doc/install) must be installed in order to build the project.
+
+You can used the command ```go get``` can be used to retrieve and build the project directly from GitHub.
 
-### Install and build packages
 ```bash
-go get github.com/fhussonnois/kafkacli/cmd/kafkaconnectcli
+go get github.com/fhussonnois/kafkacli/cmd/...
 ```
 
-or...
+The script ```./release.sh``` can be used to package project tar.gz for all OS/architectures.
 
-```bash
-./release.sh
-```
+## Kafka Connect CLI
+
+A simple Command line interface (CLI) to manage connectors through the Kafka Connect REST Interface.
 
 ### Run command
 ```bash
@@ -34,11 +35,11 @@ or...
 
 ### Usage
 
-```bash
+```
 A simple Command line interface (CLI) to manage connectors through the Kafka Connect REST Interface.
 
-Usage of ./bin/kafka-connect-cli: command [arguments] 
-The commands are : 
+Usage of ./bin/kafka-connect-cli: command [arguments]
+The commands are :
 
     list            Listing active connectors on a worker.
     config          Getting connector configuration.
@@ -59,7 +60,9 @@ Use "kafka-connect-cli help [command]" for more information about that command.
 
 ```
 
-### Create new connector instance
+### Examples
+
+#### How to create a new connector instance ?
 
 A new connector configuration can be passed through either json or properties file.
 
@@ -80,27 +83,30 @@ The arguments are :
     	Pretty print json output.
 ```
 
-## Confluent Schema registry
+#### How to display all connectors with failed tasks ?
 
-A simple Command line interface (CLI) to manage [Confluent](http://docs.confluent.io/current/schema-registry/docs/api.html) Schema Registry.
+Sometime it can be useful to quickly identify which connectors have failed tasks.
 
-### Install and build packages
 ```bash
-go get github.com/fhussonnois/kafkacli/cmd/schemaregistrycli
+./kafka-connect-cli list -pretty -with-state failed
 ```
 
+## Confluent Schema registry
+
+A simple Command line interface (CLI) to manage [Confluent](http://docs.confluent.io/current/schema-registry/docs/api.html) Schema Registry.
+
 ### Run command
 ```bash
 ./bin/schema-registry-cli
 ```
 
 ### Usage
 
-```bash
+```
 A simple Command line interface (CLI) to manage Confluent Schema Registry.
 
-Usage of ./bin/schemaregistrycli: command [arguments] 
-The commands are : 
+Usage of ./bin/schemaregistrycli: command [arguments]
+The commands are :
 
 	compatibility            Getting subject compatibility level for a subject.
 	exist                    Checking if a schema has already been registered under the specified subject
@@ -115,6 +121,16 @@ The commands are :
 Use "schema-registry-cli help [command]" for more information about that command.
 ```
 
+### Examples
+
+#### How to retrieve only Avro schema from subject version ?
+
+The option `schema` can be used to retieve only Avro schema of given subject without the version of the SchemaRegistry.
+
+```bash
+./bin/schema-registry-cli get -pretty -schema -subject mySubject-value
+```
+
 ## Contributions
 Any contribution is welcome
 
@@ -123,4 +139,4 @@ Licensed to the Apache Software Foundation (ASF) under one or more contributor l
 
 http://www.apache.org/licenses/LICENSE-2.0
 
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License