1# logfmt
 2
 3[![Go Reference](https://pkg.go.dev/badge/github.com/go-logfmt/logfmt.svg)](https://pkg.go.dev/github.com/go-logfmt/logfmt)
 4[![Go Report Card](https://goreportcard.com/badge/go-logfmt/logfmt)](https://goreportcard.com/report/go-logfmt/logfmt)
 5[![Github Actions](https://github.com/go-logfmt/logfmt/actions/workflows/test.yml/badge.svg)](https://github.com/go-logfmt/logfmt/actions/workflows/test.yml)
 6[![Coverage Status](https://coveralls.io/repos/github/go-logfmt/logfmt/badge.svg?branch=master)](https://coveralls.io/github/go-logfmt/logfmt?branch=main)
 7
 8Package logfmt implements utilities to marshal and unmarshal data in the [logfmt
 9format][fmt]. It provides an API similar to [encoding/json][json] and
10[encoding/xml][xml].
11
12[fmt]: https://brandur.org/logfmt
13[json]: https://pkg.go.dev/encoding/json
14[xml]: https://pkg.go.dev/encoding/xml
15
16The logfmt format was first documented by Brandur Leach in [this
17article][origin]. The format has not been formally standardized. The most
18authoritative public specification to date has been the documentation of a Go
19Language [package][parser] written by Blake Mizerany and Keith Rarick.
20
21[origin]: https://brandur.org/logfmt
22[parser]: https://pkg.go.dev/github.com/kr/logfmt
23
24## Goals
25
26This project attempts to conform as closely as possible to the prior art, while
27also removing ambiguity where necessary to provide well behaved encoder and
28decoder implementations.
29
30## Non-goals
31
32This project does not attempt to formally standardize the logfmt format. In the
33event that logfmt is standardized this project would take conforming to the
34standard as a goal.
35
36## Versioning
37
38This project publishes releases according to the Go language guidelines for
39[developing and publishing modules][pub].
40
41[pub]: https://go.dev/doc/modules/developing