Merge pull request #105 from nils-a/feature/GH-99

(#99) created a simple README

.gitignore

@@ -345,4 +345,5 @@ BuildArtifacts/*
 .DS_Store
 
 # Wyam
-docs/input/tasks
+docs/input/tasks
+/config.wyam.*

README.md

@@ -0,0 +1,36 @@
+# Cake.DotNetVersionDetector
+
+Cake.DotNetVersionDetector is set of aliases for [Cake][0] that help simplify using [ASoft .NET Version Detector][1].
+
+[![License](http://img.shields.io/:license-mit-blue.svg)][2]
+
+## Information
+
+| |Stable|Pre-release|
+|:--:|:--:|:--:|
+|GitHub Release|-|[![GitHub release](https://img.shields.io/github/release/cake-contrib/Cake.DotNetVersionDetector.svg)][3]|
+|NuGet|[![MyGet](https://img.shields.io/myget/cake-contrib/vpre/Cake.DotNetVersionDetector.svg)][4]|[![NuGet](https://img.shields.io/nuget/vpre/Cake.DotNetVersionDetector.svg)][5]|
+
+## Build Status
+
+|Develop|Master|
+|:--:|:--:|
+|[![Build status][6]][7]|[![Build status][8]][7]|
+
+## Quick Links
+
+- [API Documentation][9]
+- [Usage Examples][10]
+
+
+[0]: https://cakebuild.net/
+[1]: https://www.asoft.be/prod_netver.html
+[2]: https://mit-license.org/
+[3]: https://github.com/cake-contrib/Cake.DotNetVersionDetector/releases/latest
+[4]: https://www.myget.org/feed/cake-contrib/package/nuget/Cake.DotNetVersionDetector
+[5]: https://www.nuget.org/packages/Cake.DotNetVersionDetector
+[6]: https://github.com/cake-contrib/Cake.DotNetVersionDetector/actions/workflows/build.yml/badge.svg?branch=develop
+[7]: https://github.com/cake-contrib/Cake.DotNetVersionDetector/actions/workflows/build.yml
+[8]: https://github.com/cake-contrib/Cake.DotNetVersionDetector/actions/workflows/build.yml/badge.svg?branch=master
+[9]: https://cakebuild.net/dsl/DotNetVersionDetector/
+[10]: https://cake-contrib.github.io/Cake.DotNetVersionDetector/docs/usage/examples

Source/Cake.DotNetVersionDetector/Cake.DotNetVersionDetector.csproj

@@ -9,6 +9,10 @@
     <Company>Cake Contributors</Company>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="$(ProjectDir)../../README.md" Link="README.md" PackagePath="" Pack="true" />
+  </ItemGroup>
+
   <PropertyGroup>
     <!-- I am lazy, so I don't want to update the year every time a new year
           comes around -->
@@ -32,6 +36,7 @@
     <RepositoryUrl>$(PackageSourceProjectUrl).git</RepositoryUrl>
     <PackageReleaseNotes Condition=" '$(Version)' == '$(FileVersion)'">All release notes for $(AssemblyName) can be found on our GitHub release page - $(PackageSourceProjectUrl)/releases/tag/$(Version)</PackageReleaseNotes>
     <PackageReleaseNotes Condition=" '$(Version)' != '$(FileVersion)'">Development releases do not contain release notes, please see the closed issues in these cases - $(PackageSourceProjectUrl)/issues?q=milestone:$(FileVersion)+is:closed</PackageReleaseNotes>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>

docs/input/docs/usage/examples.md

@@ -1,6 +1,17 @@
 ---
 Title: Examples
 ---
+# Install the DotNetVersionDetector
+
+The DotNetVersionDetector (`dotnetversion.exe`) needs to be installed on your system before
+Cake.DotNetVersionDetector can make use of it.
+
+You can download and install it manually from the [ASoft website](https://www.asoft.be/prod_netver.html).
+Alternatively, you can install it by utilizing [Chocolatey](https://chocolatey.org):
+
+```pwsh
+choco install dotnetversiondetector
+```
 
 # Basic Usage
 

docs/input/index.cshtml

@@ -8,6 +8,6 @@ NoGutter: true
 <div class="container">
 	<h1>What is it?</h1>
     <p>
-        Cake.DotNetVersionDetector is an Addin for <a href="http://cakebuild.net/">Cake</a> which allows executing the DotNetVersionDetector exectuable.
+        Cake.DotNetVersionDetector is an Addin for <a href="http://cakebuild.net/">Cake</a> which allows executing the <a href="https://www.asoft.be/prod_netver.html">ASoft .NET Version Detector</a> exectuable.
     </p>
 </div>