Skip to content

Commit

Permalink
Mention removal of go-toml/query (#736)
Browse files Browse the repository at this point in the history
Fixes #722
  • Loading branch information
pelletier authored Jan 7, 2022
1 parent 146f70e commit 3f5d8a6
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ encouraged to try out this version.

## Documentation

Full API, examples, and implementation notes are available in the Go documentation.
Full API, examples, and implementation notes are available in the Go
documentation.

[![Go Reference](https://pkg.go.dev/badge/github.com/pelletier/go-toml/v2.svg)](https://pkg.go.dev/github.com/pelletier/go-toml/v2)

Expand Down Expand Up @@ -565,6 +566,19 @@ fmt.Println(string(b))

[nodoc]: /~https://github.com/pelletier/go-toml/discussions/506#discussioncomment-1526038

### `query`

go-toml v1 provided the [`go-toml/query`][query] package. It allowed to run
JSONPath-style queries on TOML files. This feature is not available in v2. For a
replacement, check out [dasel][dasel].

This package has been removed because it was essentially not supported anymore
(last commit May 2020), increased the complexity of the code base, and more
complete solutions exist out there.

[query]: /~https://github.com/pelletier/go-toml/tree/f99d6bbca119636aeafcf351ee52b3d202782627/query
[dasel]: /~https://github.com/TomWright/dasel

## License

The MIT License (MIT). Read [LICENSE](LICENSE).

0 comments on commit 3f5d8a6

Please sign in to comment.