Added documentation (Readme, Changelog)

elendil-software · Feb 3, 2019 · 0ae209a · 0ae209a
1 parent f95fca6
commit 0ae209a
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 2 deletions.
diff --git a/AASharp.Extension.sln b/AASharp.Extension.sln
@@ -5,7 +5,14 @@ VisualStudioVersion = 15.0.28307.329
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AASharp.Extension", "Src\AASharp.Extension\AASharp.Extension.csproj", "{9FBD793E-F614-473D-A2FC-49B409EDD8D4}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AASharp.Extension.Test", "Test\AASharp.Extension.Test\AASharp.Extension.Test.csproj", "{610B38D6-2C95-42CC-A7E5-6319EFCF8DEA}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AASharp.Extension.Test", "Test\AASharp.Extension.Test\AASharp.Extension.Test.csproj", "{610B38D6-2C95-42CC-A7E5-6319EFCF8DEA}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{927B4118-97D8-47ED-8136-2BD58D250561}"
+	ProjectSection(SolutionItems) = preProject
+		CHANGELOG.md = CHANGELOG.md
+		LICENSE = LICENSE
+		README.md = README.md
+	EndProjectSection
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,18 @@
+# Changelog
+
+## [0.1.1] - 2019-02-03
+
+### Added
+
+- Changelog
+
+### Updated
+
+- NuGet package description
+- Readme file
+
+## [0.1.0] - 2019-02-02
+
+### Added
+
+- Method allowing to get the constellation corresponding to given coordinates
diff --git a/README.md b/README.md
@@ -1 +1,5 @@
-# AASharp.Extension
+# AASharp.Extension
+
+AASharp.Extension provides helper classes and methods allowing using [AASharp](https://github.com/jsauve/AASharp) more easily.
+
+Currently very few functions are available, but others will be added. Feel free to open an [issue](https://github.com/elendil-software/AASharp.Extension/issues) to suggest new capability.
diff --git a/Src/AASharp.Extension/AASharp.Extension.csproj b/Src/AASharp.Extension/AASharp.Extension.csproj
@@ -17,6 +17,7 @@
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <AssemblyVersion>0.1.0.0</AssemblyVersion>
     <FileVersion>0.1.0.0</FileVersion>
+    <Description>AASharp.Extension provides helper classes and methods allowing using AASharp more easily.</Description>
   </PropertyGroup>
 
   <ItemGroup>