From 53019c0667f21b43dfda8c39b26cb5887a36e47e Mon Sep 17 00:00:00 2001
From: "Erik A. Brandstadmoen" <erik@brandstadmoen.net>
Date: Wed, 10 Nov 2021 23:18:24 +0100
Subject: [PATCH] Added Nuget readme file (#133)

Solves #68
---
 docs/index.md      |  4 ++--
 grate/NuGet.md     | 30 ++++++++++++++++++++++++++++++
 grate/grate.csproj | 19 +++++++++----------
 3 files changed, 41 insertions(+), 12 deletions(-)
 create mode 100644 grate/NuGet.md

diff --git a/docs/index.md b/docs/index.md
index 0895c03a..30e7edee 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -8,7 +8,7 @@ SQL scripts migration runner
 
 ## What is grate?
 
-grate is a SQL scripts migration runner, using plan, old SQL for migrations. No meta-language, no code, no config,
+grate is a SQL scripts migration runner, using plain, old SQL for migrations. No meta-language, no code, no config,
 no EF migrations. If gives you full flexibility, and full control of your migrations, and lets you use
 all the fancy features of you particular database system. You are not constrained to any lowest common 
 feature set of all supported databases.
@@ -43,7 +43,7 @@ grate is short for migrate. And it's also pronounced the same way as _great_, so
 * [Getting started](GettingStarted.md)
 * [Getting grate](GettingGrate.md)
 * [Migrating from RoundhousE](MigratingFromRoundhousE.md)
-* [Configuration Options](ConfigurationOptions)
+* [Configuration Options](ConfigurationOptions/index.md)
 * [Environment scripts](EnvironmentScripts.md)
 * [Token replacement](TokenReplacement.md)
 * [Response files](ConfigurationOptions/ResponseFiles.md)
diff --git a/grate/NuGet.md b/grate/NuGet.md
new file mode 100644
index 00000000..5cd4d567
--- /dev/null
+++ b/grate/NuGet.md
@@ -0,0 +1,30 @@
+# grate
+
+grate is a SQL scripts migration runner, using plain, old SQL for migrations. No meta-language, no code, no config,
+no EF migrations. If gives you full flexibility, and full control of your migrations, and lets you use
+all the fancy features of you particular database system. You are not constrained to any lowest common
+feature set of all supported databases.
+
+## Minimal example
+The only required argument to pass to grate is a **connection string** to tell it where to find your database. 
+It will deploy to that database, looking for sql scripts in the current directory.
+
+```
+grate --connectionstring="Server=(localdb)\MSSQLLocalDB;Integrated Security=true;Database=grate_test"
+```
+
+for more configuration options, see the [documentation](https://erikbra.github.io/grate/configuration-options/).
+
+
+
+## grate supports the following DMBS's
+
+* Microsoft SQL server
+* PostgreSQL
+* MariaDB/MySQL
+* Sqlite
+* _(Oracle support is in the works)_
+
+Full documentation can be found at [https://erikbra.github.io/grate/](https://erikbra.github.io/grate/).
+
+
diff --git a/grate/grate.csproj b/grate/grate.csproj
index 68fc641f..a5eacc2f 100644
--- a/grate/grate.csproj
+++ b/grate/grate.csproj
@@ -7,14 +7,16 @@
     <Nullable>enable</Nullable>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <Authors>Erik A. Brandstadmoen</Authors>
+    <PackageReadmeFile>NuGet.md</PackageReadmeFile>
     <Description>
-      grate - sql for the 20s
+grate - sql for the 20s
     
-      grate is a no-code, low-fi database migration tool, inspired heavily by RoundhousE. It's written from the ground
-      up using modern .NET 6. 
+grate is a no-code, low-fi database migration tool, inspired heavily by RoundhousE. It's written from the ground
+up using modern .NET 6. 
     </Description>
     <PackageProjectUrl>https://erikbra.github.io/grate/</PackageProjectUrl>
     <RepositoryUrl>https://github.com/erikbra/grate</RepositoryUrl>
+    <RepositoryType>git</RepositoryType>
     <PackageTags>sql migration roundhouse</PackageTags>
   </PropertyGroup>
   
@@ -34,16 +36,13 @@
     <DebugType>None</DebugType>
     <RuntimeIdentifier Condition="'$(RuntimeIdentifier)' == ''">win-x64</RuntimeIdentifier>
     <RuntimeIdentifiers>win-x64;win-x86;win-arm;win-arm64;alpine-x64;linux-x64;linux-arm;linux-arm64;osx.11.0-x64;osx.10.12-x64;osx-x64</RuntimeIdentifiers>
-
-    <!-- <PublishSingleFile>true</PublishSingleFile>
-    <PublishTrimmed>true</PublishTrimmed>
-    <PublishReadyToRun>false</PublishReadyToRun>
-    <TrimMode>link</TrimMode>
-    <IncludeAllContentForSelfExtract>true</IncludeAllContentForSelfExtract> -->
-
     <ToolCommandName>grate</ToolCommandName>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="NuGet.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
   <PropertyGroup Condition="'$(SelfContained)' == 'true'">
     <PublishSingleFile>true</PublishSingleFile>
     <PublishTrimmed>true</PublishTrimmed>