Add badges, installation instructions, usage examples, and contributi…

…on guidelines sections

README.md

@@ -1,2 +1,42 @@
 # httprouter
-A Go-Chi router wrapper offering preconfigured setups and helpers for enhanced routing
+
+[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/dmitrymomot/httprouter)](https://github.com/dmitrymomot/httprouter)
+[![Go Reference](https://pkg.go.dev/badge/github.com/dmitrymomot/httprouter.svg)](https://pkg.go.dev/github.com/dmitrymomot/httprouter)
+[![License](https://img.shields.io/github/license/dmitrymomot/httprouter)](https://github.com/dmitrymomot/httprouter/blob/main/LICENSE)
+
+[![Tests](https://github.com/dmitrymomot/httprouter/actions/workflows/tests.yml/badge.svg)](https://github.com/dmitrymomot/httprouter/actions/workflows/tests.yml)
+[![CodeQL Analysis](https://github.com/dmitrymomot/httprouter/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/dmitrymomot/httprouter/actions/workflows/codeql-analysis.yml)
+[![GolangCI Lint](https://github.com/dmitrymomot/httprouter/actions/workflows/golangci-lint.yml/badge.svg)](https://github.com/dmitrymomot/httprouter/actions/workflows/golangci-lint.yml)
+[![Go Report Card](https://goreportcard.com/badge/github.com/dmitrymomot/httprouter)](https://goreportcard.com/report/github.com/dmitrymomot/httprouter)
+
+The `httprouter` package is a go-chi/chi router wrapper offering pre configured setups and helpers for enhanced development flow speed.
+
+## Features
+
+TODO: Add features
+
+## Installation
+
+To install the `httprouter` package, use the following command:
+
+```bash
+go get github.com/dmitrymomot/httprouter
+```
+
+## Usage
+
+TODO: Add usage examples
+
+## Contributing
+
+Contributions to the `httprouter` package are welcome! Here are some ways you can contribute:
+
+- Reporting bugs
+- Additional tests cases
+- Suggesting enhancements
+- Submitting pull requests
+- Sharing the love by telling others about this project
+
+## License
+
+This project is licensed under the [MIT](LICENSE) - see the `LICENSE` file for details.