Skip to content

Commit

Permalink
Adding top-level docs links to README (#125)
Browse files Browse the repository at this point in the history
This should hopefully help people find things. See #124
  • Loading branch information
etianen committed Feb 24, 2024
1 parent 6bd88bf commit 78d2476
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,26 @@ def test_something(logot: Logot) -> None:

## Documentation 📖

Full documentation is published on [Read the Docs](https://logot.readthedocs.io).
Full documentation is published on [Read the Docs](https://logot.readthedocs.io). Learn more about `logot` with the following guides:

- [Log message matching](https://logot.readthedocs.io/latest/log-message-matching.html)
- [Log pattern matching](https://logot.readthedocs.io/latest/log-pattern-matching.html)
- [Log capturing](https://logot.readthedocs.io/latest/log-capturing.html)
- [Using with `pytest`](https://logot.readthedocs.io/latest/using-pytest.html)
- [Using with `unittest`](https://logot.readthedocs.io/latest/using-unittest.html)
- [Installing](https://logot.readthedocs.io/latest/installing.html)


## Bugs / feedback 🐛

Issue tracking is hosted on [GitHub](https://github.com/etianen/logot/issues).


## Changelog 🏗️

Release notes are published on [GitHub](https://github.com/etianen/logot/releases).


## License ⚖️

`logot` is published as open-source software under the [MIT license](https://github.com/etianen/logot/blob/main/LICENSE).

0 comments on commit 78d2476

Please sign in to comment.