diff --git a/README.md b/README.md index 337dc01..1b7d68a 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,16 @@
Table of Contents
    -
  1. Usage
  2. +
  3. + Usage + +
  4. Contributing
  5. +
  6. Tests
  7. Contact
  8. License
@@ -32,49 +40,46 @@ _An automatically generated and interactive API documentation with (live) respon
-**Mods** +##### Mods -/api/v1/mods: Get all mods +**/api/v1/mods**: Get all mods - Include: `revisions` | `revisions.executable` - Sort: `name` | `projectUrl` - Example: `/api/v1/mods?include=revisions.executable&sort[projectUrl]` -/api/v1/mods/{id}: Get mod by id +**/api/v1/mods/{id}**: Get mod by id - Include: `revisions` | `revisions.executable` - Sort: `name` | `projectUrl` - Example: `/api/v1/mods/1337?include=revisions.executable&sort[projectUrl]`
-**Revisions** +##### Revisions -/api/v1/revisions: Get all revisions +**/api/v1/revisions**: Get all revisions - Include: `executable` | `mod` | `executable,mod` - Sort: `version` - Example: `/api/v1/revisions?include=executable,mod&sort[version]` -/api/v1/revisions/{id}: Get revision by id +**/api/v1/revisions/{id}**: Get revision by id - Include: `executable` | `mod` | `executable,mod` - Sort: `version` - Example: `/api/v1/revisions/1337?include=executable,mod&sort[version]`
-**Executables** +##### Executables -/api/v1/executables: Get all executables +**/api/v1/executables**: Get all executables - Include: `revisions` | `revisions.mod` - Sort: `name` | `key` - Example: `/api/v1/executables?include=revisions.mod&sort[name]` -/api/v1/executables/{id}: Get executable by id +**/api/v1/executables/{id}**: Get executable by id - Include: `revisions` | `revisions.mod` - Sort: `name` | `key` - Example: `/api/v1/executables/1337?include=revisions.mod&sort[name]` - - -
## Contributing @@ -97,11 +102,22 @@ php artisan json:import 4. Serve the project via `php artisan serve` or [Laravel Homestead](https://fourplayers.atlassian.net/wiki/spaces/4NET/pages/1035206657/Homestead+Installation). +
+ +## Tests + +Tests are available.\ +A HTML coverage report is available in tests/Coverage. + +
+ ## Contact Marlon Maschkiwitz - marlon.maschkiwitz@4players.io
Project Link - https://gitlab.4players.de/4np/apis/docker-minecraft-api +
+ ## License Distributed under the MIT License. See `LICENSE.txt` for more information.