docs(readme): document the routing convention details

Author: jaredcnance

JsonApiDotnetCore.sln

@@ -15,6 +15,7 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{C5B4D998-CECB-454D-9F32-085A897577BE}"
 	ProjectSection(SolutionItems) = preProject
 		.gitignore = .gitignore
+		README.md = README.md
 	EndProjectSection
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NoEntityFrameworkExample", "src\NoEntityFrameworkExample\NoEntityFrameworkExample.csproj", "{570165EC-62B5-4684-A139-8D2A30DD4475}"

README.md

@@ -248,9 +248,10 @@ services.AddJsonApi<AppDbContext>(
 #### Disable Convention
 
 You can disable the dasherized convention and specify your own template
-by using the `DisableRoutingConvention` Attribute:
+by using the `DisableRoutingConvention` Attribute. 
 
 ```csharp
+[Route("[controller]")]
 [DisableRoutingConvention]
 public class CamelCasedModelsController : JsonApiController<CamelCasedModel>
 {
@@ -263,6 +264,22 @@ public class CamelCasedModelsController : JsonApiController<CamelCasedModel>
 }
 ```
 
+It is important to note that your routes *must* still end with the model name in the same format
+as the resource name. This is so that we can build accurrate resource links in the json:api document.
+For example, if you define a resource as `MyModels` the controller route must match:
+
+```csharp
+// resource definition
+builder.AddResource<TodoItem>("myModels");
+
+// controller definition
+[Route("api/myModels")]
+[DisableRoutingConvention]
+public class TodoItemsController : JsonApiController<TodoItem>
+{ //...
+}
+```
+
 ### Defining Custom Data Access Methods
 
 By default, data retrieval is distributed across 3 layers:
@@ -287,7 +304,7 @@ public void ConfigureServices(IServiceCollection services)
     services.AddJsonApi(options => {
         options.Namespace = "api/v1";
         options.BuildContextGraph((builder) => {
-            builder.AddResource<MyModel>("my-models");
+            builder.AddResource<MyModel>("my-models");1
         });
     }, mvcBuilder);
     // ...