Skip to content

Commit

Permalink
Clarify documentation, bump patch version
Browse files Browse the repository at this point in the history
  • Loading branch information
mangiucugna committed Sep 5, 2024
1 parent 838374c commit e12238e
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,24 +118,24 @@ Install the library for command-line with:
```
pipx install json-repair
```
then run
to know all options available:
```
$ json_repair -h
usage: json_repair [-h] [-i] [--ensure_ascii] [--indent INDENT] filename
usage: json_repair [-h] [-i] [-o TARGET] [--ensure_ascii] [--indent INDENT] filename
Repair and parse JSON files.
positional arguments:
filename The JSON file to repair
filename The JSON file to repair
options:
-h, --help show this help message and exit
-i, --inline Replace the file inline instead of returning the output to stdout
--ensure_ascii Pass the ensure_ascii parameter to json.dumps()
--indent INDENT Number of spaces for indentation (Default 2)
-h, --help show this help message and exit
-i, --inline Replace the file inline instead of returning the output to stdout
-o TARGET, --output TARGET
If specified, the output will be written to TARGET filename instead of stdout
--ensure_ascii Pass ensure_ascii=True to json.dumps()
--indent INDENT Number of spaces for indentation (Default 2)
```
to learn how to use it

## Adding to requirements
**Please pin this library only on the major version!**
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"
[project]
name = "json_repair"
version = "0.29.0"
version = "0.29.1"
license = {file = "LICENSE"}
authors = [
{ name="Stefano Baccianella", email="4247706+mangiucugna@users.noreply.github.com" },
Expand Down

0 comments on commit e12238e

Please sign in to comment.