Add README.md

PxTools · Nov 23, 2023 · 6b79b4b · 6b79b4b
1 parent 30f3c82
commit 6b79b4b
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 2 deletions.
diff --git a/PCAxis.Sql/PCAxis.Sql.csproj b/PCAxis.Sql/PCAxis.Sql.csproj
@@ -8,13 +8,14 @@
     <MinVerSkip Condition="'$(Configuration)' == 'Debug'">true</MinVerSkip>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <Description>Reading Sql-database into Paxiom.</Description>
-    <PackageLicenseFile>LICENSE</PackageLicenseFile>
     <PackageProjectUrl>https://github.com/statisticssweden/PCAxis.Sql</PackageProjectUrl>
     <RepositoryUrl>https://github.com/statisticssweden/PCAxis.Sql.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <IncludeSymbols>true</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     <PackageTags>PX</PackageTags>
+    <PackageLicenseFile>LICENSE</PackageLicenseFile>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
   </PropertyGroup>
 
@@ -55,6 +56,9 @@
       <Pack>True</Pack>
       <PackagePath></PackagePath>
     </None>
+    <None Include="..\README.md">
+      <Pack>True</Pack>
+      <PackagePath></PackagePath>
+    </None>
   </ItemGroup>
-
 </Project>
diff --git a/README.md b/README.md
@@ -0,0 +1,21 @@
+# PCAxis.Sql
+
+This repository contains the SQL components required for connecting to a 
+[CNMM database](https://www.scb.se/en/services/statistical-programs-for-px-files/px-web/px-web-med-sql-databas/)
+
+## Contributing
+
+We welcome contributions to this project. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+## License
+
+This project is licensed under the Apache-2.0 License - see the [LICENSE](LICENSE) file for details.
+
+## Support and Feedback
+
+For support, feature requests, and bug reporting, please open an issue on the [GitHub project page](https://github.com/statisticssweden/PCAxis.Sql/issues).
+
+## See Also
+
+- [PxWeb Project Website](https://www.scb.se/en/services/statistical-programs-for-px-files/px-web/)
+- [PxWeb on GitHub](https://github.com/statisticssweden/PxWeb)