From 8efc48e55d9815c079df35a1bea5e8aea58999c8 Mon Sep 17 00:00:00 2001 From: Dmitry Shirshov Date: Sat, 9 Nov 2024 16:13:01 +0300 Subject: [PATCH] chore(readme): add usage instructions --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 35bb601..3525a42 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# 🛠️ rekson +# ⚡ rekson rectify your json ## 🍎 Motivation @@ -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