Merge pull request #320 from samhanes/netstandard-docs

Add documentation for Net Core

SqlClient.sln

@@ -32,6 +32,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "content", "content", "{4B60
 		docs\content\debugging.fsx = docs\content\debugging.fsx
 		docs\content\faq.fsx = docs\content\faq.fsx
 		docs\content\index.fsx = docs\content\index.fsx
+		docs\content\netcore.md = docs\content\netcore.md
 		docs\content\output.fsx = docs\content\output.fsx
 		docs\content\setup.fsx = docs\content\setup.fsx
 		docs\content\SqlClientComparison.md = docs\content\SqlClientComparison.md

docs/content/bulk load.fsx

@@ -1,5 +1,5 @@
 (*** hide ***)
-#r @"..\..\bin\FSharp.Data.SqlClient.dll"
+#r @"..\..\bin\net40\FSharp.Data.SqlClient.dll"
 #r "System.Transactions"
 open FSharp.Data
 open System

docs/content/configuration and Input.fsx

@@ -1,5 +1,5 @@
 (*** hide ***)
-#r @"..\..\bin\FSharp.Data.SqlClient.dll"
+#r @"..\..\bin\net40\FSharp.Data.SqlClient.dll"
 #r "Microsoft.SqlServer.Types.dll"
 (**
 

docs/content/data modification.fsx

@@ -1,5 +1,5 @@
 (*** hide ***)
-#r @"..\..\bin\FSharp.Data.SqlClient.dll"
+#r @"..\..\bin\net40\FSharp.Data.SqlClient.dll"
 #r "System.Transactions"
 open FSharp.Data
 open System

docs/content/debugging.fsx

@@ -1,5 +1,5 @@
 (*** hide ***)
-#r @"..\..\bin\FSharp.Data.SqlClient.dll"
+#r @"..\..\bin\net40\FSharp.Data.SqlClient.dll"
 #r "System.Transactions"
 open FSharp.Data
 open System

docs/content/faq.fsx

@@ -1,5 +1,5 @@
 (*** hide ***)
-#r @"..\..\bin\FSharp.Data.SqlClient.dll"
+#r @"..\..\bin\net40\FSharp.Data.SqlClient.dll"
 #r "System.Transactions"
 open FSharp.Data
 

docs/content/index.fsx

@@ -1,6 +1,6 @@
 (*** hide ***)
 #r "Microsoft.SqlServer.Types.dll"
-#r @"..\..\bin\FSharp.Data.SqlClient.dll"   
+#r @"..\..\bin\net40\FSharp.Data.SqlClient.dll"   
 
 (**
 Not your grandfather's ORM

docs/content/netcore.md

@@ -0,0 +1,19 @@
+Support for .NET Core
+=====================
+
+As of version 2.0.1, a `netstandard2.0`-targeted version of FSharp.Data.SqlClient is available. 
+This means you should be able to reference and use the type provider from a .NET Core application, 
+with the following caveats and exceptions:
+
+* The type provider is split into two different assemblies, `FSharp.Data.SqlClient.dll` 
+(the runtime component or RTC) and `FSharp.Data.SqlClient.DesignTime.dll` (the design-time component or DTC).
+  * The RTC (and its dependencies) must be available at runtime; they end up in the bin folder
+  alongside your application's compiled assemblies. The FSharp.Data.SqlClient RTC is available for
+  both `net40` and `netstandard2.0` and is thus fully compatible with .NET Core 2.0 applications.
+  * The DTC is required to make the provided types available to your design-time tooling and to the
+  compiler. The FSharp.Data.SqlClient DTC *has .NET Framework-only dependencies* (`Microsoft.SqlServer.Types`
+  and `Microsoft.SqlServer.TransactSql.ScriptDom`). As such, either .NET Framework or Mono must be
+  installed in order to compile your .NET Core application. Additionally, you must import `fsc.props`
+  in your .fsproj/.csproj file - please see more detailed instructions [here](https://github.com/Microsoft/visualfsharp/issues/3303).
+* As mentioned above, `Microsoft.SqlServer.Types` only targets .NET Framework, so you will not be able to use types such as [HierarchyId](http://technet.microsoft.com/en-us/library/bb677173.aspx) or
+[spatial types](http://blogs.msdn.com/b/adonet/archive/2013/12/09/microsoft-sqlserver-types-nuget-package-spatial-on-azure.aspx) from your .NET Core app.

docs/content/output.fsx

@@ -1,5 +1,5 @@
 (*** hide ***)
-#r @"..\..\bin\FSharp.Data.SqlClient.dll"
+#r @"..\..\bin\net40\FSharp.Data.SqlClient.dll"
 #r "Microsoft.SqlServer.Types.dll"
 open FSharp.Data
 [<Literal>]

docs/content/setup.fsx

@@ -1,5 +1,5 @@
 #nowarn "211"
-#r @"..\..\bin\FSharp.Data.SqlClient.dll"
+#r @"..\..\bin\net40\FSharp.Data.SqlClient.dll"
 #r "System.Transactions"
 
 open FSharp.Data

docs/content/transactions.fsx

@@ -1,5 +1,5 @@
 (*** hide ***)
-#r @"..\..\bin\FSharp.Data.SqlClient.dll"
+#r @"..\..\bin\net40\FSharp.Data.SqlClient.dll"
 #r "System.Transactions"
 open FSharp.Data
 

docs/content/unit-testing.fsx

@@ -1,5 +1,5 @@
 (*** hide ***)
-#r @"..\..\bin\FSharp.Data.SqlClient.dll"
+#r @"..\..\bin\net40\FSharp.Data.SqlClient.dll"
 #r @"..\..\packages\Test\xunit\lib\net20\xunit.dll"
 #r "System.Transactions"
 open FSharp.Data
@@ -87,7 +87,7 @@ module MyTests =
 
     //unit test
     let ``best sales rep in Canada``() = 
-        let expected = Some( GetSalesChampion.Record("José", "Saraiva"))
+        let expected = Some( GetSalesChampion.Record("José", "Saraiva"))
         assert (bestSalesRepInCanada mockRepository = expected)        
 
 

docs/content/whatsnew.fsx

@@ -1,6 +1,6 @@
 (*** hide ***)
 #r "Microsoft.SqlServer.Types.dll"
-#r @"..\..\bin\FSharp.Data.SqlClient.dll"   
+#r @"..\..\bin\net40\FSharp.Data.SqlClient.dll"   
 
 open FSharp.Data
 

docs/tools/templates/template.cshtml

@@ -50,8 +50,9 @@
 
                     <li class="nav-header">Documentation</li>
                     <li><a href="@Root/whatsnew.html">What's New</a></li>
+                    <li><a href="@Root/netcore.html">Support for .NET Core</a></li>
                     <li><a href="@Root/configuration and input.html">Configuration and Input</a></li>
-                    <li><a href="@Root/output.html">Output</a></li>
+                    <li><a href="@Root/output.html">Output</a></li>                    
                     <li><a href="@Root/faq.html">FAQ</a></li>
                     <li class="divider"></li>
                     <li><a href="@Root/data modification.html">Data Modification</a></li>

src/SqlClient.TestProjects/Lib/Script.fsx

@@ -1,4 +1,4 @@
-#r @"..\..\..\bin\FSharp.Data.SqlClient.dll"
+#r @"..\..\..\bin\net40\FSharp.Data.SqlClient.dll"
 #r @"bin\Debug\Lib.dll"
 #r @"System.Configuration"
 #r @"System.Transactions"