diff --git a/README.md b/README.md index 800556a2..2018bf02 100644 --- a/README.md +++ b/README.md @@ -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).