• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

.github/workflows/H18-Aug-2021-

.gitignoreH A D18-Aug-20219

CHANGELOG.mdH A D18-Aug-20211.5 KiB

LICENSEH A D18-Aug-20211.1 KiB

README.mdH A D18-Aug-20211.7 KiB

decode-bench_test.goH A D18-Aug-2021601

decode.goH A D18-Aug-20214.9 KiB

decode_test.goH A D18-Aug-20214.1 KiB

doc.goH A D18-Aug-2021336

encode.goH A D18-Aug-20217.8 KiB

encode_internal_test.goH A D18-Aug-20216.2 KiB

encode_test.goH A D18-Aug-20217.2 KiB

example_test.goH A D18-Aug-20211 KiB

go.modH A D18-Aug-202144

jsonstring.goH A D18-Aug-20215.1 KiB

README.md

1[![Go Reference](https://pkg.go.dev/badge/github.com/go-logfmt/logfmt.svg)](https://pkg.go.dev/github.com/go-logfmt/logfmt)
2[![Go Report Card](https://goreportcard.com/badge/go-logfmt/logfmt)](https://goreportcard.com/report/go-logfmt/logfmt)
3[![Github Actions](https://github.com/go-logfmt/logfmt/actions/workflows/test.yml/badge.svg)](https://github.com/go-logfmt/logfmt/actions/workflows/test.yml)
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
8Package logfmt implements utilities to marshal and unmarshal data in the [logfmt
9format](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
13The logfmt format was first documented by Brandur Leach in [this
14article](https://brandur.org/logfmt). The format has not been formally
15standardized. The most authoritative public specification to date has been the
16documentation of a Go Language [package](http://godoc.org/github.com/kr/logfmt)
17written by Blake Mizerany and Keith Rarick.
18
19## Goals
20
21This project attempts to conform as closely as possible to the prior art, while
22also removing ambiguity where necessary to provide well behaved encoder and
23decoder implementations.
24
25## Non-goals
26
27This project does not attempt to formally standardize the logfmt format. In the
28event that logfmt is standardized this project would take conforming to the
29standard as a goal.
30
31## Versioning
32
33Package logfmt publishes releases via [semver](http://semver.org/) compatible Git tags prefixed with a single 'v'.
34