update readme and add ci scripts

Author: jaredcnance

.travis.yml

@@ -0,0 +1,7 @@
+language: csharp
+dist: trusty
+sudo: required
+mono: none
+dotnet: 1.0.0-preview2-1-003177
+script:
+  - ./build.sh

Build.ps1

@@ -0,0 +1,64 @@
+<#
+.SYNOPSIS
+    You can add this to you build script to ensure that psbuild is available before calling
+    Invoke-MSBuild. If psbuild is not available locally it will be downloaded automatically.
+#>
+function EnsurePsbuildInstalled{
+    [cmdletbinding()]
+    param(
+        [string]$psbuildInstallUri = 'https://raw.githubusercontent.com/ligershark/psbuild/master/src/GetPSBuild.ps1'
+    )
+    process{
+        if(-not (Get-Command "Invoke-MsBuild" -errorAction SilentlyContinue)){
+            'Installing psbuild from [{0}]' -f $psbuildInstallUri | Write-Verbose
+            (new-object Net.WebClient).DownloadString($psbuildInstallUri) | iex
+        }
+        else{
+            'psbuild already loaded, skipping download' | Write-Verbose
+        }
+
+        # make sure it's loaded and throw if not
+        if(-not (Get-Command "Invoke-MsBuild" -errorAction SilentlyContinue)){
+            throw ('Unable to install/load psbuild from [{0}]' -f $psbuildInstallUri)
+        }
+    }
+}
+
+# Taken from psake https://github.com/psake/psake
+
+<#
+.SYNOPSIS
+  This is a helper function that runs a scriptblock and checks the PS variable $lastexitcode
+  to see if an error occcured. If an error is detected then an exception is thrown.
+  This function allows you to run command-line programs without having to
+  explicitly check the $lastexitcode variable.
+.EXAMPLE
+  exec { svn info $repository_trunk } "Error executing SVN. Please verify SVN command-line client is installed"
+#>
+function Exec
+{
+    [CmdletBinding()]
+    param(
+        [Parameter(Position=0,Mandatory=1)][scriptblock]$cmd,
+        [Parameter(Position=1,Mandatory=0)][string]$errorMessage = ($msgs.error_bad_command -f $cmd)
+    )
+    & $cmd
+    if ($lastexitcode -ne 0) {
+        throw ("Exec: " + $errorMessage)
+    }
+}
+
+if(Test-Path .\artifacts) { Remove-Item .\artifacts -Force -Recurse }
+
+EnsurePsbuildInstalled
+
+exec { & dotnet restore }
+
+Invoke-MSBuild
+
+$revision = @{ $true = $env:APPVEYOR_BUILD_NUMBER; $false = 1 }[$env:APPVEYOR_BUILD_NUMBER -ne $NULL];
+$revision = "{0:D4}" -f [convert]::ToInt32($revision, 10)
+
+exec { & dotnet test .\test\JsonApiDotNetCoreExampleTests -c Release }
+
+exec { & dotnet pack .\src\JsonApiDotNetCore -c Release -o .\artifacts --version-suffix=$revision }

README.md

@@ -2,19 +2,42 @@
 
 # Generators
 
-- TODO: Document usage of the yeoman jadn generator
+You can install the [Yeoman generators](https://github.com/Research-Institute/json-api-dotnet-core-generators) 
+to make building applications much easier.
 
 ## Usage
 
-- Add Middleware
+You need to do 3 things:
+
+- Add Middleware and Services
 - Define Models
 - Define Controllers
 
+I recommend reading the details below, but once you're familiar with the
+setup, you can use the Yeoman generator to generate the required classes.
+
+## Middleware and Services
+
+Add the following to your `Startup.ConfigureServices` method. 
+Replace `AppDbContext` with your DbContext. 
+
+```csharp
+services.AddJsonApi<AppDbContext>();
+```
+
+Add the middleware to the `Startup.Configure` method. 
+Note that under the hood, this will call `app.UseMvc()` 
+so there is no need to add that as well.
+
+```csharp
+app.UseJsonApi();
+```
+
 ## Defining Models
 
 Your models should inherit `Identifiable<TId>` where `TId` is the type of the primary key, like so:
 
-```
+```csharp
 public class Person : Identifiable<Guid>
 {
     public override Guid Id { get; set; }
@@ -26,7 +49,7 @@ public class Person : Identifiable<Guid>
 If you want an attribute on your model to be publicly available, 
 add the `AttrAttribute` and provide the outbound name.
 
-```
+```csharp
 public class Person : Identifiable<int>
 {
     public override int Id { get; set; }
@@ -38,9 +61,10 @@ public class Person : Identifiable<int>
 
 ### Relationships
 
-In order for navigation properties to be identified in the model, they should be labeled as virtual.
+In order for navigation properties to be identified in the model, 
+they should be labeled as virtual.
 
-```
+```csharp
 public class Person : Identifiable<int>
 {
     public override int Id { get; set; }
@@ -55,7 +79,7 @@ public class Person : Identifiable<int>
 Dependent relationships should contain a property in the form `{RelationshipName}Id`. 
 For example, a `TodoItem` may have an `Owner` and so the Id attribute should be `OwnerId` like so:
 
-```
+```csharp
 public class TodoItem : Identifiable<int>
 {
     public override int Id { get; set; }
@@ -73,7 +97,7 @@ public class TodoItem : Identifiable<int>
 You need to create controllers that inherit from `JsonApiController<TEntity>` or `JsonApiController<TEntity, TId>`
 where `TEntity` is the model that inherits from `Identifiable<TId>`.
 
-```
+```csharp
 [Route("api/[controller]")]
 public class ThingsController : JsonApiController<Thing>
 {
@@ -92,7 +116,7 @@ If your model is using a type other than `int` for the primary key,
 you should explicitly declare it in the controller
 and repository generic type definitions:
 
-```
+```csharp
 [Route("api/[controller]")]
 public class ThingsController : JsonApiController<Thing, Guid>
 {
@@ -120,7 +144,7 @@ NOT /todoItems
 
 You can add a namespace to the URL by specifying it in `ConfigureServices`:
 
-```
+```csharp
 services.AddJsonApi<AppDbContext>(
     opt => opt.Namespace = "api/v1");
 ```
@@ -130,7 +154,7 @@ services.AddJsonApi<AppDbContext>(
 If you would like pagination implemented by default, you can specify the page size
 when setting up the services:
 
-```
+```csharp
  services.AddJsonApi<AppDbContext>(
      opt => opt.DefaultPageSize = 10);
 ```
@@ -146,7 +170,6 @@ add to the service collection in `Startup.ConfigureServices` like so:
 services.AddScoped<IEntityRepository<MyEntity,Guid>, MyEntityRepository>();
 ```
 
-
 ## Filtering
 
 You can filter resources by attributes using the `filter` query parameter. 
@@ -180,5 +203,3 @@ I am using DotNetCoreDocs to generate sample requests and documentation.
 4. `cd ./src/JsonApiDotNetCoreExample`
 5. `dotnet run`
 6. `open http://localhost:5000/docs`
-
-

appveyor.yml

@@ -0,0 +1,29 @@
+version: '{build}'
+pull_requests:
+  do_not_increment_build_number: true
+branches:
+  only:
+  - master
+nuget:
+  disable_publish_on_pr: true
+build_script:
+- ps: .\Build.ps1
+test: off
+artifacts:
+- path: .\artifacts\**\*.nupkg
+  name: NuGet
+deploy:
+- provider: NuGet
+  server: https://www.myget.org/F/research-institute/api/v2/package
+  api_key:
+    secure: 6CeYcZ4Ze+57gxfeuHzqP6ldbUkPtF6pfpVM1Gw/K2jExFrAz763gNAQ++tiacq3
+  skip_symbols: true
+  on:
+    branch: master
+- provider: NuGet
+  name: production
+  api_key:
+    secure: /fsEOgG4EdtNd6DPmko9h3NxQwx1IGDcFreGTKd2KA56U2KEkpX/L/pCGpCIEf2s
+  on:
+    branch: master
+    appveyor_repo_tag: true

build.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+#exit if any command fails
+set -e
+
+artifactsFolder="./artifacts"
+
+if [ -d $artifactsFolder ]; then
+  rm -R $artifactsFolder
+fi
+
+dotnet restore
+
+dotnet test ./test/JsonApiDotNetCoreExampleTests -c Release -f netcoreapp1.0
+
+revision=${TRAVIS_JOB_ID:=1}
+revision=$(printf "%04d" $revision)
+
+dotnet pack ./src/JsonApiDotNetCore -c Release -o ./artifacts --version-suffix=$revision