Skip to content

Commit 72dded3

Browse files
authored
docs: improve readme (#9)
1 parent bbae13d commit 72dded3

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,22 @@
55
[![Go Report Card](https://goreportcard.com/badge/github.com/hedhyw/json-log-viewer)](https://goreportcard.com/report/github.com/hedhyw/json-log-viewer)
66
[![Coverage Status](https://coveralls.io/repos/github/hedhyw/json-log-viewer/badge.svg?branch=main)](https://coveralls.io/github/hedhyw/json-log-viewer?branch=main)
77

8-
It is an interactive tool for viewing and analyzing complex log files with structured JSON logs.
8+
It is an **interactive** tool for viewing and analyzing complex structured [json-log](assets/example.log) files.
99

1010
![Animation](./assets/animation.webp)
1111

1212
Main features:
1313
1. It is interactive.
14-
2. Is shows similified log records.
15-
3. It is possible to see the full prettified JSON after clicking.
16-
4. It includes non-JSON logs as they are.
17-
5. It understands different field names.
14+
2. It displays a compact list of log entries.
15+
3. It is possible to expand the log and see the full prettified JSON tree.
16+
4. All non-json logs are captured.
17+
5. It understands different field names: `time`, `timestamp`, `msg`, `message`, `err`, `error` etc.
1818
6. It supports case-insensitive filtering.
1919
7. It is simple.
2020

21-
It uses [antonmedv/fx](https://github.com/antonmedv/fx) for viewing JSON and [charmbracelet/bubbletea](https://github.com/charmbracelet/bubbletea) for terminal UI. The tool is inspired by the project [json-log-viewer](https://github.com/gistia/json-log-viewer) which is unfortunately outdated.
21+
It uses [antonmedv/fx](https://github.com/antonmedv/fx) for viewing JSON records and [charmbracelet/bubbletea](https://github.com/charmbracelet/bubbletea) for organizing the terminal UI. The tool is inspired by the project [json-log-viewer](https://github.com/gistia/json-log-viewer) which is unfortunately outdated and deserted.
22+
23+
The application is designed to help in visualization, navigation, and analyzing of JSON-formatted log data in a user-friendly and interactive manner. It provides a structured and organized view of the JSON logs, making it easier to comprehend the hierarchical nature of the data. It uses collapsible/expandable tree structures, indentation, and color-coded syntax to represent the JSON objects and arrays. It is possible to search for specific keywords, phrases, or patterns within the JSON logs. So it helps to significantly simplify the process of working with JSON logs, making it more intuitive and efficient. It is easy to troubleshoot issues, monitor system performance, or gain a deeper understanding of the application's behavior by analyzing its log data in post-mortem.
2224

2325
## Table of content
2426

@@ -31,11 +33,10 @@ It uses [antonmedv/fx](https://github.com/antonmedv/fx) for viewing JSON and [ch
3133
- [Package](#package)
3234
- [Standalone Binary](#standalone-binary)
3335
- [Source](#source)
34-
- [Roadmap](#roadmap)
3536
- [Resources](#resources)
37+
- [Contribution](#contribution)
3638
- [License](#license)
3739

38-
3940
## Usage
4041

4142
```sh
@@ -56,12 +57,14 @@ jlv file.json
5657

5758
```sh
5859
brew install hedhyw/main/jlv
60+
# jlv application.log
5961
```
6062

6163
### Go
6264

63-
```bash
65+
```sh
6466
go install github.com/hedhyw/json-log-viewer/cmd/jlv@latest
67+
# jlv application.log
6568
```
6669

6770
### Package
@@ -74,20 +77,15 @@ Download latest archive `*.tar.gz` for your target platform from [the releases p
7477

7578
### Source
7679

77-
```
80+
```sh
7881
git clone [email protected]:hedhyw/json-log-viewer.git
7982
cd json-log-viewer
8083
make build
8184
cp ./bin/jlv /usr/local/bin
8285
chmod +x /usr/local/bin/jlv
83-
```
84-
85-
## Roadmap
8686

87-
- Accept stream of logs.
88-
- Add colors to log levels.
89-
- Add a configuration file (similar to `.json-log-viewer`).
90-
- Convert number timestamps.
87+
# jlv application.log
88+
```
9189

9290
## Resources
9391

@@ -96,6 +94,10 @@ Alternatives:
9694
- [pamburus/hl](https://github.com/pamburus/hl) - A log viewer that translates JSON logs into human-readable representation.
9795
- [json-log-viewer](https://github.com/gistia/json-log-viewer) - Powerful terminal based viewer for JSON logs using ncurses.
9896

97+
## Contribution
98+
99+
Check [open unassigned issues](https://github.com/hedhyw/json-log-viewer/issues), write comments, ask questions, fork, and create a pull request.
100+
99101
## License
100102

101103
[MIT License](LICENSE).

0 commit comments

Comments
 (0)