Update 'README.md'

README.md

@@ -28,9 +28,34 @@
 
 ## Usage
 
-Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
+_An automatically generated and interactive API documentation from existing Laravel routes is available at **/idoc**._
+
+** 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/executables/{id}: Get executable by id
+- Include: `revisions` | `revisions.mod`
+- Sort: `name` | `projectUrl`
+- Example: `/api/v1/executables/1337?include=revisions.mod&sort[name]`
+
+**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
+- Include: `revisions` | `revisions.mod`
+- Sort: `name` | `key`
+- Example: `/api/v1/executables/1337?include=revisions.mod&sort[name]`
+
+
 
-_An automatically generated and interactive API documentation from existing Laravel routes is available at (idoc)._
 
 <br/>