Merge pull request #7 from cdr/docs

Docs

Author: nhooyr

README.md

@@ -5,10 +5,78 @@
 [![Codecov](https://img.shields.io/codecov/c/github/cdr/slog.svg?color=success)](https://codecov.io/gh/cdr/slog)
 [![CI](https://img.shields.io/circleci/build/github/cdr/slog?label=ci)](https://github.com/cdr/slog/commits/master)
 
-slog is a minimal and idiomatic structured logging library for Go.
+slog is a minimal structured logging library for Go.
 
 ## Install
 
 ```bash
 go get go.coder.com/slog
 ```
+
+## Features
+
+- Minimal API
+- Tiny codebase
+- First class [context.Context](https://blog.golang.org/context) support
+- Beautiful logging output by default
+- Multiple adapters
+- First class [\*testing.T](https://godoc.org/go.coder.com/slog/testlog) support
+
+## Example
+
+```
+testlog.Info(t, "my message here",
+    slog.F("field_name", "something or the other"),
+    slog.F("some_map", map[string]interface{}{
+        "nested_fields": "wowow",
+    }),
+    slog.F("some slice", []interface{}{
+        1,
+        "foof",
+        "bar",
+        true,
+    }),
+    slog.Component("test"),
+
+    slog.F("name", slog.ValueFunc(func() interface{} {
+        return "wow"
+    })),
+)
+
+// --- PASS: TestExampleTest (0.00s)
+//    test_test.go:38: Sep 06 14:33:52.628 [INFO] (test): my_message_here
+//        field_name: something or the other
+//        some_map:
+//          nested_fields: wowow
+//        error:
+//          - msg: wrap2
+//            loc: /Users/nhooyr/src/cdr/slog/test_test.go:43
+//            fun: go.coder.com/slog_test.TestExampleTest
+//          - msg: wrap1
+//            loc: /Users/nhooyr/src/cdr/slog/test_test.go:44
+//            fun: go.coder.com/slog_test.TestExampleTest
+//          - EOF
+//        name: wow
+```
+
+## Design justifications
+
+See [#9](https://github.com/cdr/slog/issues/9)
+
+## Comparison
+
+### zap
+
+https://github.com/uber-go/zap
+
+See [#6][https://github.com/cdr/slog/issues/6]
+
+## Contributing
+
+See [.github/CONTRIBUTING.md](.github/CONTRIBUTING.md).
+
+## Users
+
+If your company or project is using this library, feel free to open an issue or PR to amend this list.
+
+- [Coder](https://github.com/cdr)

ci/tools.go

@@ -6,7 +6,6 @@ package ci
 import (
 	_ "go.coder.com/go-tools/cmd/goimports"
 	_ "golang.org/x/lint/golint"
-	_ "golang.org/x/tools/cmd/stringer"
 	_ "gotest.tools/gotestsum"
 	_ "mvdan.cc/sh/cmd/shfmt"
 )

go.mod

@@ -10,7 +10,6 @@ require (
 	go.coder.com/go-tools v0.0.0-20190317003359-0c6a35b74a16
 	go.opencensus.io v0.22.1
 	golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3
-	golang.org/x/tools v0.0.0-20190311212946-11955173bddd
 	golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7
 	gotest.tools/gotestsum v0.3.5
 	mvdan.cc/sh v2.6.4+incompatible