update readme, add nuget package metadata

Author: kMutagene

BioFSharp.Stats.sln

@@ -27,6 +27,7 @@ Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "build", "build\build.fsproj
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{88932F99-4093-455A-901B-E0203694A436}"
 	ProjectSection(SolutionItems) = preProject
+		docs\GSEA.fsx = docs\GSEA.fsx
 		docs\index.fsx = docs\index.fsx
 	EndProjectSection
 EndProject
@@ -39,6 +40,11 @@ Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "BioFSharp.Stats", "src\BioF
 EndProject
 Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "BioFSharp.Stats.Tests", "tests\BioFSharp.Stats.Tests\BioFSharp.Stats.Tests.fsproj", "{17ECB3EC-8837-47F0-8F1A-3006A66126D6}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "img", "img", "{E118E505-B0F4-4D3A-B440-1E00820AF971}"
+	ProjectSection(SolutionItems) = preProject
+		docs\img\Logo_large.png = docs\img\Logo_large.png
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -65,5 +71,6 @@ Global
 		{8DCCA688-871C-49DD-BC06-4877F714497C} = {78399A41-F06A-4B35-AA24-E2E20209D8DE}
 		{EFEC7FF4-B7CB-4C70-B396-73B971A4A21A} = {7501C4DF-A844-40A0-8742-3343E48E55F1}
 		{17ECB3EC-8837-47F0-8F1A-3006A66126D6} = {D152DA0B-8F60-4611-B613-642379E2B17C}
+		{E118E505-B0F4-4D3A-B440-1E00820AF971} = {88932F99-4093-455A-901B-E0203694A436}
 	EndGlobalSection
 EndGlobal

README.md

@@ -1,45 +1,24 @@
-# PackageTemplate
-
-A template repository for creating an extension package for BioFSharp.
-
-## Content
-
-- `src/BioFSharp.XYZ`: The main project folder. Contains a library with BioFSharp core dependency.
-- `tests/BioFSharp.XYZ.Tests`: The test project folder. Contains a XUnit test project
-- `build/build.fsproj`: A FAKE build project that handles building, testing, packaging, publishing, etc.
-- `docs`: the docs folder contains an example index.fsx file with simple documentation boilerplate.
-
-## Setup
-
-Here is a list of things you should/might want to do after setting up a repo with this template:
-
-> [!IMPORTANT]  
-> Whenever you change a project file name or folder, make sure to fix the solution registration afterwards.
-
-- Rename some things: Replace `XYZ` with the name of your package
-  - `PackageTemplate.sln`
-  - `src/BioFSharp.XYZ`
-  - `src/BioFSharp.XYZ/BioFSharp.XYZ.fsproj`
-  - `tests/BioFSharp.XYZ`
-  - `tests/BioFSharp.XYZ.Tests/BioFSharp.XYZ.Tests.fsproj`
-    - Also make sure to fix the project reference to BioFSharp.XYZ when renamed
-  - in `build/ProjectInfo.fs`:
-    - Set project name: 
-      ```fsharp
-      let project = "BioFSharp.XYZ"` // replace with the name of your project
-      ```
-    - Set git owner:
-      ```fsharp
-      let gitOwner = "BioFSharp" // replace with github account name or organization where repo is hosted if necessary
-      ```
-    - fix test project path:
-      ```fsharp
-      let testProjects = 
-      [
-          "tests/BioFSharp.XYZ.Tests/BioFSharp.XYZ.Tests.fsproj" // replace with the name of your test project
-      ]
-      ```
-- If needed, change the target framework of the project. it currently targets `.net8.0`, might want to target a newer version if you need a specific API, or `netstandard2.0` for increased backwards compatibility.
+# BioFSharp.Stats
+
+![Logo](docs/img/Logo_large.png)
+
+![NuGet Version](https://img.shields.io/nuget/v/BioFSharp.Stats?label=nuget(stable))
+![NuGet Version](https://img.shields.io/nuget/vpre/BioFSharp.Stats?label=nuget(prerelease))
+
+BioFSharp.Stats contains statistical functions with a clear biological focus such as Gene Set Enrichment Analysis (GSEA).
+
+BioFSharp.Stats is part of the [BioFSharp]() extension package ecosystem.
+
+
+| Build status (ubuntu and windows) | Test Coverage |
+|---|---|
+| ![](https://github.com/BioFSharp/BioFSharp.Stats/actions/workflows/build-and-test.yml/badge.svg) | [![codecov](https://codecov.io/gh/BioFSharp/BioFSharp.Stats/branch/main/graph/badge.svg)](https://codecov.io/gh/BioFSharp/BioFSharp.Stats) |
+
+
+From 2.0.0 onwards, this package will have a decoupled release schedule from the core `BioFSharp` package.
+This means that the versioning will be independent and may not follow the same versioning scheme as `BioFSharp`.
+
+The last coupled release was `2.0.0-preview.3`.
 
 ## Build
 

docs/img/Logo_large.png

@@ -3,15 +3,34 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
   </PropertyGroup>
 
   <ItemGroup>
     <Compile Include="PhylTree.fs" />
     <Compile Include="OntologyEnrichment.fs" />
     <Compile Include="RNASeq.fs" />
     <Compile Include="SAEPT.fs" />
+    <None Include="..\..\docs\img\icon.png" Pack="true" PackagePath=""/>
   </ItemGroup>
-
+  
+  <PropertyGroup>
+    <Authors>Timo Mühlhaus, Kevin Schneider, F# open source contributors</Authors>
+    <Description>Statistical functions with a clear biological focus</Description>
+    <Summary>
+      BioFSharp.Stats contains statistical functions with a clear biological focus such as Gene Set Enrichment Analysis (GSEA).
+    </Summary>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageProjectUrl>https://BioFSharp.github.io/BioFSharp.Stats/</PackageProjectUrl>
+    <PackageIcon>icon.png</PackageIcon>
+    <PackageTags>bioinformatics F# fsharp statistic biostatistics datascience</PackageTags>
+    <RepositoryUrl>https://github.com/BioFSharp/BioFSharp.Stats</RepositoryUrl>
+    <RepositoryType>git</RepositoryType>
+    <FsDocsLicenseLink>https://github.com/BioFSharp/BioFSharp.Stats/blob/main/LICENSE</FsDocsLicenseLink>
+    <FsDocsReleaseNotesLink>https://github.com/BioFSharp/BioFSharp.Stats/blob/main/RELEASE_NOTES.md</FsDocsReleaseNotesLink>
+  </PropertyGroup>
+  
   <ItemGroup>
     <PackageReference Include="BioFSharp" Version="2.0.0-preview.3" />
     <PackageReference Include="FSharp.Stats" Version="0.6.0" />