Merge #298: Add README to packages

09da301 docs: [#295] add README to packages (Jose Celano)

Pull request description:

  It's just a simple README for workspace packages with a link to the documentation.

Top commit has no ACKs.

Tree-SHA512: 31f92f4a871e687137c4463a6172c89e1686cf768587b9c19f30c54579069d641671ac14391cfd925f000544867c85065bd02a00ad72f25c0790233dafcb05e1

README.md

@@ -56,7 +56,9 @@ After running the tracker these services will be available:
 ## Documentation
 
 * [Crate documentation](https://docs.rs/torrust-tracker/).
-* [API documentation](https://torrust.github.io/torrust-documentation/torrust-tracker/api/).
+* [API `v1`](https://docs.rs/torrust-tracker/3.0.0-alpha.1/torrust_tracker/servers/apis/v1).
+* [HTTP Tracker](https://docs.rs/torrust-tracker/3.0.0-alpha.1/torrust_tracker/servers/http).
+* [UDP Tracker](https://docs.rs/torrust-tracker/3.0.0-alpha.1/torrust_tracker/servers/udp).
 
 ## Contributing
 
@@ -66,7 +68,7 @@ How can you contribute?
 
 * Bug reports and feature requests.
 * Code contributions. You can start by looking at the issues labeled ["good first issues"](https://github.com/torrust/torrust-tracker/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
-* Documentation improvements. Check the [documentation](https://docs.rs/torrust-tracker/) and [API documentation](https://torrust.github.io/torrust-documentation/torrust-tracker/api/) for typos, errors, or missing information.
+* Documentation improvements. Check the [documentation](https://docs.rs/torrust-tracker/) and [API documentation](https://docs.rs/torrust-tracker/3.0.0-alpha.1/torrust_tracker/servers/apis/v1) for typos, errors, or missing information.
 * Participation in the community. You can help by answering questions in the [discussions](https://github.com/torrust/torrust-tracker/discussions).
 
 ## License

packages/configuration/README.md

@@ -0,0 +1,11 @@
+# Torrust Tracker Configuration
+
+A library to provide configuration to the [Torrust Tracker](https://github.com/torrust/torrust-tracker).
+
+## Documentation
+
+[Crate documentation](https://docs.rs/torrust-tracker-configuration).
+
+## License
+
+The project is licensed under the terms of the [GNU AFFERO GENERAL PUBLIC LICENSE](./LICENSE).

packages/located-error/README.md

@@ -0,0 +1,11 @@
+# Torrust Tracker Located Error
+
+A library to provide an error decorator with the location and the source of the original error.
+
+## Documentation
+
+[Crate documentation](https://docs.rs/torrust-tracker-located-error).
+
+## License
+
+The project is licensed under the terms of the [GNU AFFERO GENERAL PUBLIC LICENSE](./LICENSE).

packages/primitives/README.md

@@ -0,0 +1,11 @@
+# Torrust Tracker Primitives
+
+A library with the primitive types shared by the [Torrust Tracker](https://github.com/torrust/torrust-tracker) packages.
+
+## Documentation
+
+[Crate documentation](https://docs.rs/torrust-tracker-primitives).
+
+## License
+
+The project is licensed under the terms of the [GNU AFFERO GENERAL PUBLIC LICENSE](./LICENSE).

packages/test-helpers/README.md

@@ -0,0 +1,11 @@
+# Torrust Tracker Configuration
+
+A library providing helpers for testing the [Torrust Tracker](https://github.com/torrust/torrust-tracker).
+
+## Documentation
+
+[Crate documentation](https://docs.rs/torrust-tracker-test-helpers).
+
+## License
+
+The project is licensed under the terms of the [GNU AFFERO GENERAL PUBLIC LICENSE](./LICENSE).