Update homebrew formula and add docs

Author: chclaus

.goreleaser.yml

@@ -38,7 +38,6 @@ brew:
     owner: chclaus
     name: dt
   folder: Formula
-  caveats: "CLI tool for common dev tasks."
   homepage: "https://github.com/chclaus/dt"
   description: "CLI tool for common dev tasks."
   install: |

Formula/dt.rb

@@ -9,8 +9,4 @@ def install
     bin.install "dt"
   end
 
-  def caveats; <<~EOS
-    CLI tool for common dev tasks.
-  EOS
-  end
 end

README.md

@@ -1,14 +1,16 @@
 [![Build Status](https://travis-ci.org/chclaus/dt.svg?branch=master)](https://travis-ci.org/chclaus/dt)
 [![Go Report](https://goreportcard.com/badge/github.com/chclaus/dt)](https://goreportcard.com/report/github.com/chclaus/dt)
 
-# Intro
+# dt - the dev toolbelt
+
 The dev toolbelt is a fast and flexible tool to handle common use
 cases of your daily work. Use cases you generally use some online
 tools.
 
-# Table of Contents
+## Table of Contents
 
 - [Example](#example)
+- [Installation](#installation)
 - [Commands](#commands)
   * [URI](#uri-command)
   * [Base64](#base64-command)
@@ -22,33 +24,61 @@ tools.
 - [License](#license)
 
 # Example
-        Usage:
-          dt [command]
+    Usage:
+      dt [command]
+
+    Available Commands:
+      base64      Encodes or decodes a string to it's base64 representation
+      date        Basic date operations
+      hash        Hashes an arbitrary input with different hash algorithms
+      help        Help about any command
+      html        Escapes a html string and vice versa
+      jwt         Allows decoding of a jwt
+      server      Starts a simple web server to serve static content
+      random      Generates random numbers and strings
+      uri         Encodes or decodes an URI
+      version     Prints the current version of the dt
+
+    Flags:
+      -h, --help   help for dt
+
+    Use "dt [command] --help" for more information about a command.
+
+## Installation
+If you've go installed and your `$GOPATH` is set, you can easily install
+dt with:
 
-        Available Commands:
-          base64      Encodes or decodes a string to it's base64 representation
-          date        Basic date operations
-          hash        Hashes an arbitrary input with different hash algorithms
-          help        Help about any command
-          html        Escapes a html string and vice versa
-          jwt         Allows decoding of a jwt
-          server      Starts a simple web server to serve static content
-          random      Generates random numbers and strings
-          uri         Encodes or decodes an URI
-          version     Prints the current version of the dt
+    go get github.com/chclaus/dt
 
-        Flags:
-          -h, --help   help for dt
+### Install via Homebrew
 
-        Use "dt [command] --help" for more information about a command.
+    brew tap chclaus/dt [email protected]:chclaus/dt.git
+    brew install dt
 
-# Commands
+### Build
+To build the project you can clone the repository with...
+
+    git clone [email protected]:chclaus/dt
+
+... and build and install the binary with
 
-## URI command
+    cd dt && go install
+
+### Build with Docker
+To build the repository with docker, do the following:
+
+    git clone [email protected]:chclaus/dt
+    cd dt
+    docker build -t dt .
+    docker run --rm dt version
+
+## Commands
+
+### URI command
 - Encodes an URI to a safe representation
 - Decodes an already encoded URI
 
-## Base64 command
+### Base64 command
 - Encodes a string to it's base64 representation
 - Decodes a base64 string to it's plain representation
 
@@ -58,7 +88,7 @@ The base64 command can be used with different encodings:
 - URL, follows the alternative RFC 4648
 - URL Raw, follows the alternative RFC 4648 but with without padding
 
-## Hash command
+### Hash command
 Returns the hash representation of an input in different hash formats:
 - md5
 - sha1
@@ -68,65 +98,41 @@ Returns the hash representation of an input in different hash formats:
 - sha512
 - bcrypt
 
-## JWT command
+### JWT command
 Decodes a jwt and pretty prints the resulting json.
 
 Further TODOs:
 - Signature validation
 - JWT creation
 
-## Random command
+### Random command
 Generates random strings and numbers. Currently supported functions are:
 - Generates a random string, based on an alphabet with a specific length.
 - Generates a random string with alphanumeric letters.
 - Generates a random string with a alphanumeric and special characters.
 - Generates random numbers with a specific length.
 
-## Date command
+### Date command
 Date conversions:
 - time millis to RFC 3339
 - time nanos to RFC 3339
 - RFC 3339 to time millis
 
-## Regex command
+### Regex command
 TODO
 
-## HTML command
+### HTML command
 Escapes and unescapes HTML
 - transforms a string to an escaped html sequence
 - reads a file and prints an escaped html sequence
 - unescapes an escaped html sequence to it's raw representation
 
-## Server
+### Server
 Starts a simple web server to serve static content. You can specify
 hostname and port and must set a folder to serve.
 
 
-# Get dt
-## Install
-If you've go installed and your `$GOPATH` is set, you can easily install
-dt with:
-
-        go get github.com/chclaus/dt
-
-## Build
-To build the project you can clone the repository with...
-
-        git clone [email protected]:chclaus/dt
-
-... and build and install the binary with
-
-        cd dt && go install
-
-## Build with Docker
-To build the repository with docker, do the following:
-
-        git clone [email protected]:chclaus/dt
-        cd dt
-        docker build -t dt .
-        docker run --rm dt version
-
-# Contributing
+## Contributing
 Everyone is welcome to create pull requests for this project. If you're
 new to github, take a look [here](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/)
 to get an idea of it.
@@ -135,5 +141,5 @@ If you've got an idea of a function that should find it's way into this
 project, but you won't implement it by yourself, please create a new
 issue.
 
-# License
+## License
 dt (dev-toolbelt) is released under the MIT license. See [LICENSE.txt](LICENSE.txt)

cmd/version/version.go

@@ -32,7 +32,7 @@ var versionCmd = &cobra.Command{
 	Short: "Prints the current version of the dt",
 	Long:  "All software has versions. This is dt's",
 	Run: func(cmd *cobra.Command, args []string) {
-		fmt.Println("dt - the dev toolbelt v0.0.2")
+		fmt.Println("dt - the dev toolbelt v0.1.2")
 	},
 	Example: ``,
 }