vendor/github.com/go-logfmt/logfmt/README.md

   1 [![GoDoc](https://godoc.org/github.com/go-logfmt/logfmt?status.svg)](https://godoc.org/github.com/go-logfmt/logfmt)
   2 [![Go Report Card](https://goreportcard.com/badge/go-logfmt/logfmt)](https://goreportcard.com/report/go-logfmt/logfmt)
   3 [![TravisCI](https://travis-ci.org/go-logfmt/logfmt.svg?branch=master)](https://travis-ci.org/go-logfmt/logfmt)
   4 [![Coverage Status](https://coveralls.io/repos/github/go-logfmt/logfmt/badge.svg?branch=master)](https://coveralls.io/github/go-logfmt/logfmt?branch=master)
   5
   6 # logfmt
   7
   8 Package logfmt implements utilities to marshal and unmarshal data in the [logfmt
   9 format](https://brandur.org/logfmt). It provides an API similar to
  10 [encoding/json](http://golang.org/pkg/encoding/json/) and
  11 [encoding/xml](http://golang.org/pkg/encoding/xml/).
  12
  13 The logfmt format was first documented by Brandur Leach in [this
  14 article](https://brandur.org/logfmt). The format has not been formally
  15 standardized. The most authoritative public specification to date has been the
  16 documentation of a Go Language [package](http://godoc.org/github.com/kr/logfmt)
  17 written by Blake Mizerany and Keith Rarick.
  18
  19 ## Goals
  20
  21 This project attempts to conform as closely as possible to the prior art, while
  22 also removing ambiguity where necessary to provide well behaved encoder and
  23 decoder implementations.
  24
  25 ## Non-goals
  26
  27 This project does not attempt to formally standardize the logfmt format. In the
  28 event that logfmt is standardized this project would take conforming to the
  29 standard as a goal.
  30
  31 ## Versioning
  32
  33 Package logfmt publishes releases via [semver](http://semver.org/) compatible Git tags prefixed with a single 'v'.