formatting

README.md

@@ -6,8 +6,9 @@ Analysis tool for Nextcloud logs files
 
 ## Quickstart
 
-Download the binary from the [releases page](https://github.com/icewind1991/logsmash/releases), place it somewhere in
-your `$PATH` and make it executable.
+Download the binary from the
+[releases page](https://github.com/icewind1991/logsmash/releases), place it
+somewhere in your `$PATH` and make it executable.
 
 ```bash
 logsmash ./logfile.log
@@ -15,34 +16,37 @@ logsmash ./logfile.log
 
 ## Log files
 
-Logsmash supports both loading plain log files, compressed log files (`.gz`, `.bz2`, `.xz` or `.zst`), or archives
-containing log files (`.zip` or (compressed) `.tar`).
+Logsmash supports both loading plain log files, compressed log files (`.gz`,
+`.bz2`, `.xz` or `.zst`), or archives containing log files (`.zip` or
+(compressed) `.tar`).
 
 ### Date formats
 
-Since not all log files use the same date format, logsmash tries to parse each data with a number of different log
-formats.
+Since not all log files use the same date format, logsmash tries to parse each
+data with a number of different log formats.
 
-If the log file you're opening is using an unsupported log format, you can specify a custom date format with the
-`--date-format` option.
+If the log file you're opening is using an unsupported log format, you can
+specify a custom date format with the `--date-format` option.
 
-The data format can either be in [the strftime format](https://man7.org/linux/man-pages/man3/strftime.3.html) or
-in [the time crate format (version 2)](https://time-rs.github.io/book/api/format-description.html).
+The data format can either be in
+[the strftime format](https://man7.org/linux/man-pages/man3/strftime.3.html) or
+in
+[the time crate format (version 2)](https://time-rs.github.io/book/api/format-description.html).
 
 For example: `[day].[month].[year] - [hour]:[minute]:[second]`.
 
 ## Log sources
 
-Logsmash is built around matching log line to their source, either a call to a logging function or an exception being
-thrown.
-Many log lines do not include information about their source to logsmash attempts to find the source of the log by
-comparing
-the logged message against a list of known log sources included in the binary.
+Logsmash is built around matching log line to their source, either a call to a
+logging function or an exception being thrown. Many log lines do not include
+information about their source to logsmash attempts to find the source of the
+log by comparing the logged message against a list of known log sources included
+in the binary.
 
-Since multiple log sources can create similar log lines, some lines will match to multiple log sources, in those cases
-logsmash
-will show all the matched sources as a single item.
-Log items that cannot be matched to any known source are grouped together
+Since multiple log sources can create similar log lines, some lines will match
+to multiple log sources, in those cases logsmash will show all the matched
+sources as a single item. Log items that cannot be matched to any known source
+are grouped together
 
 ## UI overview
 
@@ -50,14 +54,15 @@ Logsmash contains the following UI pages:
 
 ### Overview
 
-Shows a list of all matched sources with their source location, the number of log items matched to the source, and a
-graph of log occurrence over time.
+Shows a list of all matched sources with their source location, the number of
+log items matched to the source, and a graph of log occurrence over time.
 
 Selecting an item will bring you to the source overview for the log source.
 
 ### Source overview
 
-Shows a list of distinct log lines (lines with the same message, level and context).
+Shows a list of distinct log lines (lines with the same message, level and
+context).
 
 Selecting an item will bring you to the log list
 
@@ -69,22 +74,23 @@ Selecting an item will bring you to the log page
 
 ### Log page
 
-Shows the message and accompanying metadata for the log line. For log lines with exceptions, the exception backtrace is
-shown.
+Shows the message and accompanying metadata for the log line. For log lines with
+exceptions, the exception backtrace is shown.
 
 ### Log occurrence graph
 
-Lists that contain grouped log lines come with a graph that show how often the group of log lines occurred over time as
-a histogram.
-Each line in the list will show a small version of the graph, and a larger version of the graph for the selected item is
-shown above the list.
+Lists that contain grouped log lines come with a graph that show how often the
+group of log lines occurred over time as a histogram. Each line in the list will
+show a small version of the graph, and a larger version of the graph for the
+selected item is shown above the list.
 
 ## Keyboard controls
 
 - All lists are navigated with the arrow keys, `PgUp`/`PgDown` and `Home`/`End`.
 - Items in lists can be selected with `Enter` or the right arrow key.
 - You can return to the previous page with `Esc` or the left arrow key.
-- Single log items can be copied as json with `c` (requires [OSC 52 support](https://github.com/ojroques/vim-oscyank))
+- Single log items can be copied as json with `c` (requires
+  [OSC 52 support](https://github.com/ojroques/vim-oscyank))
 
 ## Supported data
 
@@ -119,14 +125,16 @@ Currently, the program can match against data from the following sources:
 
 ## Building
 
-The preferred way of building is trough [`nix`](https://nixos.org/download/#download-nix), this ensures that all baked
+The preferred way of building is trough
+[`nix`](https://nixos.org/download/#download-nix), this ensures that all baked
 data is automatically up-to-date.
 
 `nix build .#logsmash`
 
 #### Updating baked data
 
-Note that this is only needed when building with cargo, building with nix automatically uses the latest data.
+Note that this is only needed when building with cargo, building with nix
+automatically uses the latest data.
 
 ```bash
 rm -r data/src/data