Document the debug logs in the readme

This commit is contained in:
David Dworken 2022-11-14 16:32:39 -08:00
parent 119e57b615
commit e05300c732
No known key found for this signature in database

View File

@ -119,6 +119,11 @@ hiSHtory imports your existing shell history by default. If for some reason this
You can configure a custom timestamp format for hiSHtory via `hishtory config-set timestamp-format '2006/Jan/2 15:04'`. The timestamp format string should be in [the format used by Go's `time.Format(...)`](https://pkg.go.dev/time#Time.Format).
</details>
<details>
<summary>Viewing debug logs</summary>
Debug logs are stored in `~/.hishtory/hishtory.log`. If you run into any issues, these may contain useful information.
</details>
<details>
<summary>Uninstalling</summary>
If you'd like to uninstall hishtory, just run `hishtory uninstall`. Note that this deletes the SQLite DB storing your history, so consider running a `hishtory export` first.