summaryrefslogtreecommitdiff
path: root/vendor/github.com/alexflint/go-scalar/README.md
diff options
context:
space:
mode:
authorAlex Flint <[email protected]>2017-02-17 20:57:21 -0800
committerGitHub <[email protected]>2017-02-17 20:57:21 -0800
commit2c249ee1fcc1d48bb2e8071c3396f7c97a383dd3 (patch)
treeab73e8fc3d578d10e172553c2a6ddcd886b9136f /vendor/github.com/alexflint/go-scalar/README.md
parent765ccf745937c16486999600ecf789c646ac2e6c (diff)
parent44a8b85d8250005629dd43d78b3e305bc57e1e24 (diff)
Merge pull request #46 from alexflint/vendoring
vendor in dependencies
Diffstat (limited to 'vendor/github.com/alexflint/go-scalar/README.md')
-rw-r--r--vendor/github.com/alexflint/go-scalar/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/vendor/github.com/alexflint/go-scalar/README.md b/vendor/github.com/alexflint/go-scalar/README.md
new file mode 100644
index 0000000..e6f510e
--- /dev/null
+++ b/vendor/github.com/alexflint/go-scalar/README.md
@@ -0,0 +1,28 @@
+[![GoDoc](https://godoc.org/github.com/alexflint/go-scalar?status.svg)](https://godoc.org/github.com/alexflint/go-scalar)
+[![Build Status](https://travis-ci.org/alexflint/go-scalar.svg?branch=master)](https://travis-ci.org/alexflint/go-scalar)
+[![Coverage Status](https://coveralls.io/repos/alexflint/go-scalar/badge.svg?branch=master&service=github)](https://coveralls.io/github/alexflint/go-scalar?branch=master)
+[![Report Card](https://goreportcard.com/badge/github.com/alexflint/go-scalar)](https://goreportcard.com/badge/github.com/alexflint/go-scalar)
+
+## Scalar parsing library
+
+Scalar is a library for parsing strings into arbitrary scalars (integers,
+floats, strings, booleans, etc). It is helpful for tasks such as parsing
+strings passed as environment variables or command line arguments.
+
+```shell
+go get github.com/alexflint/go-scalar
+```
+
+The main API works as follows:
+
+```go
+var value int
+err := scalar.Parse(&value, "123")
+```
+
+There is also a variant that takes a `reflect.Value`:
+
+```go
+var value int
+err := scalar.ParseValue(reflect.ValueOf(&value), "123")
+```