From e1da1140a743c42c2a074fa5be5f7d083f299b64 Mon Sep 17 00:00:00 2001
From: Marcos Minond <minond.marcos@gmail.com>
Date: Sat, 12 Jan 2019 12:20:19 -0700
Subject: [PATCH] readme relayout

---
 README.md | 124 +++++++++++++++++++++---------------------------------
 1 file changed, 47 insertions(+), 77 deletions(-)

diff --git a/README.md b/README.md
index 25dc614..a75e5fc 100644
--- a/README.md
+++ b/README.md
@@ -1,91 +1,61 @@
-## null-extended [![GoDoc](https://godoc.org/github.com/volatiletech/null?status.svg)](https://godoc.org/github.com/volatiletech/null) [![Coverage](http://gocover.io/_badge/github.com/volatiletech/null)](http://gocover.io/github.com/volatiletech/null)
+## null [![GoDoc](https://godoc.org/github.com/volatiletech/null?status.svg)](https://godoc.org/github.com/volatiletech/null) [![Coverage](http://gocover.io/_badge/github.com/volatiletech/null)](http://gocover.io/github.com/volatiletech/null)
 
-null-extended is a library with reasonable options for dealing with nullable SQL and JSON values
+`null` is a library with reasonable options for dealing with nullable SQL and
+JSON values.
 
-Types in `null` will only be considered null on null input, and will JSON encode to `null`.
+Types in `null` will only be considered null on null input, and will JSON
+encode to `null`.
 
-All types implement `sql.Scanner` and `driver.Valuer`, so you can use this library in place of `sql.NullXXX`. All types also implement: `encoding.TextMarshaler`, `encoding.TextUnmarshaler`, `json.Marshaler`, `json.Unmarshaler` and `sql.Scanner`.
+All types implement `sql.Scanner` and `driver.Valuer`, so you can use this
+library in place of `sql.NullXXX`. All types also implement:
+`encoding.TextMarshaler`, `encoding.TextUnmarshaler`, `json.Marshaler`,
+`json.Unmarshaler` and `sql.Scanner`.
 
 ---
 
-Install:
+### Installation
 
 Null used to be versioned with gopkg.in, so once you upgrade to v8 and beyond
-please stop using gopkg.in and ensure you're using `vgo`, `dep` or vendoring
-to version null.
+please stop using gopkg.in and ensure you're using `vgo`, `dep` or vendoring to
+version null.
+
+```
+go get -u "github.com/volatiletech/null"
+```
+
+### Usage
+
+The following are all types supported in this package. All types will marshal
+to JSON null if Invalid or SQL source data is null.
+
+| Type | Description | Notes |
+|------|-------------|-------|
+| `null.JSON` | Nullable `[]byte` | Will marshal to JSON null if Invalid. `[]byte{}` input will not produce an Invalid JSON, but `[]byte(nil)` will. This should be used for storing raw JSON in the database. Also has `null.JSON.Marshal` and `null.JSON.Unmarshal` helpers to marshal and unmarshal foreign objects. |
+| `null.Bytes` | Nullable `[]byte` | `[]byte{}` input will not produce an Invalid Bytes, but `[]byte(nil)` will. This should be used for storing binary data (bytes in PSQL for example) in the database. |
+| `null.String` | Nullable `string` | |
+| `null.Byte` | Nullable `byte` | |
+| `null.Bool` | Nullable `bool` | |
+| `null.Time` | Nullable `time.Time | Marshals to JSON null if SQL source data is null. Uses `time.Time`'s marshaler. |
+| `null.Float32` | Nullable `float32` | |
+| `null.Float64` | Nullable `float64` | |
+| `null.Int` | Nullable `int` | |
+| `null.Int8` | Nullable `int8` | |
+| `null.Int16` | Nullable `int16` | |
+| `null.Int32` | Nullable `int32` | |
+| `null.Int64` | Nullable `int64` | |
+| `null.Uint` | Nullable `uint` | |
+| `null.Uint8` | Nullable `uint8` | |
+| `null.Uint16` | Nullable `uint16` | |
+| `null.Uint32` | Nullable `int32` | |
+| `null.Int64` | Nullable `uint64` | | |
 
-`go get -u "github.com/volatiletech/null"`
-
-### null package
-
-`import "github.com/volatiletech/null"`
-
-The following are all types supported in this package. All types will marshal to JSON null if Invalid or SQL source data is null.
-
-#### null.JSON
-Nullable []byte.
-
-Will marshal to JSON null if Invalid. []byte{} input will not produce an Invalid JSON, but []byte(nil) will. This should be used for storing raw JSON in the database.
-
-Also has `null.JSON.Marshal` and `null.JSON.Unmarshal` helpers to marshal and unmarshal foreign objects.
-
-#### null.Bytes
-Nullable []byte.
-
-[]byte{} input will not produce an Invalid Bytes, but []byte(nil) will. This should be used for storing binary data (bytea in PSQL for example) in the database.
-
-#### null.String
-Nullable string.
-
-#### null.Byte
-Nullable byte.
-
-#### null.Bool
-Nullable bool.
-
-#### null.Time
-Nullable time.Time
-
-Marshals to JSON null if SQL source data is null. Uses `time.Time`'s marshaler.
-
-#### null.Float32
-Nullable float32.
-
-#### null.Float64
-Nullable float64.
-
-#### null.Int
-Nullable int.
-
-#### null.Int8
-Nullable int8.
-
-#### null.Int16
-Nullable int16.
-
-#### null.Int32
-Nullable int32.
-
-#### null.Int64
-Nullable int64.
-
-#### null.Uint
-Nullable uint.
-
-#### null.Uint8
-Nullable uint8.
-
-#### null.Uint16
-Nullable uint16.
-
-#### null.Uint32
-Nullable int32.
+### Bugs
 
-#### null.Int64
-Nullable uint64.
+`json`'s `",omitempty"` struct tag does not work correctly right now. It will
+never omit a null or empty String. This might be [fixed
+eventually](https://github.com/golang/go/issues/4357).
 
-### Bugs
-`json`'s `",omitempty"` struct tag does not work correctly right now. It will never omit a null or empty String. This might be [fixed eventually](https://github.com/golang/go/issues/4357).
 
 ### License
+
 BSD