Skip to content

Commit

Permalink
chore(readme): add usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
pinbraerts committed Nov 9, 2024
1 parent 9411c00 commit 8efc48e
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 🛠️ rekson
# rekson
rectify your json

## 🍎 Motivation
Expand Down Expand Up @@ -55,6 +55,25 @@ cargo install --git https://github.com/pinbraerts/rekson
### Binary
Prebuilt binaries can be found at the [releases](https://github.com/pinbraerts/rekson/releases) page.

## 🛠️ Usage

Pass dirty json to stdin, receive fixed json in stdout.

### [conform.nvim](https://github.com/stevearc/conform.nvim)

```lua
require("conform").setup({
formatters = {
rekson = {
command = "rekson",
},
},
formatters_by_ft = {
json = { "rekson" },
})
})
```

## 👀 Alternatives
- https://github.com/adhocore/php-json-fixer
- https://github.com/rhysd/fixjson
Expand Down

0 comments on commit 8efc48e

Please sign in to comment.