Skip to content

Commit 7e0b9ae

Browse files
committed
docs: add more details to readme
1 parent 5fa3a58 commit 7e0b9ae

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

readme.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@
33
A single-file GUI for your php log files which groups similar errors. Written in PHP and Vue.js.
44

55
- Reads the specified log file and automatically shows you new errors when they appear.
6-
- Groups errors with similar text (this is far from perfect and just works with )
7-
- Can be configured so clicking on an error will directly bring you to vscode.
6+
- Groups errors with similar text. This is far from perfect and just works with the (default) log-format like:
7+
```[12-Jun-2030 12:58:55] PHP Notice: ...```
8+
- Can be configured so clicking on an error will directly [bring you to the mentioned file and line in vscode](https://code.visualstudio.com/docs/editor/command-line#_opening-vs-code-with-urls).
89

9-
## Disclamer
10+
## Disclaimer
1011
- This contains code for deleting your log-file.
1112
- Might be heavy for you server for large log files (regexp-parsing).
1213
- It is meant for development-environments.
1314
- Created for log-files in the format ``[31-Mar-2021 14:25:56 UTC] PHP Notice: ...``
14-
- There is still room for improvement (especially where the log-file is parsed)
15+
- There is still room for improvement (especially where the log-file is parsed).
1516

1617

1718
## Getting Started

0 commit comments

Comments
 (0)