Merge pull request #8 from Leo-Corporation/dev

Version 1.1.0.2301

NUGET_README.md

@@ -0,0 +1,50 @@
+![GitHub contributors](https://img.shields.io/github/contributors/Leo-Corporation/Synethia)
+![GitHub issues](https://img.shields.io/github/issues/Leo-Corporation/Synethia)
+![GitHub](https://img.shields.io/github/license/Leo-Corporation/Synethia)
+![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/Leo-Corporation/Synethia/dotnet-core-desktop.yml?branch=main)
+![Using PeyrSharp](https://img.shields.io/badge/using-PeyrSharp-DD00FF?logo=nuget)
+![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Leo-Corporation/Synethia)
+
+# Synethia
+A basic C# algorithm that can determine the behavior of a user with an application.
+
+
+[Report Bug](https://github.com/Leo-Corporation/Synethia/issues/new?assignees=&labels=bug&template=bug-report.yml&title=%5BBug%5D+) · [Request Feature](https://github.com/Leo-Corporation/Synethia/issues/new?assignees=&labels=enhancement&template=feature-request.yml&title=%5BEnhancement%5D+) · [Known Issues](https://github.com/Leo-Corporation/Synethia/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
+
+## Features
+- [x] Detects how long the user is using which part of an app. (like a page)
+- [x] Detects how many interactions the user has with an app. (like clicking on a button)
+- [x] Calculates and associates a score to each page/part of the app depending on the two factors above.
+
+More features are coming soon.
+
+## Score
+Synethia attributes a score to each page/part of the app depending on the following two factors:
+- The time the user is using the page.
+- The number of interactions the user has with the page.
+
+The score is calculated using the following formula:
+
+~~~
+score = totalTime * (interactions / 2)
+~~~
+
+> **Note** This formula can change/evolve in upcoming releases.
+
+## Graph
+Mermaid is unsupported on NuGet.
+[Click here to see the graph](https://github.com/Leo-Corporation/Synethia).
+
+
+## Contribute
+To contribute to the project, you'll need:
+- Visual Studio 2022 v17.0 or higher
+  - .NET Desktop Development
+  - Git
+- .NET 5, 6, 7
+
+
+[Click here](https://github.com/Leo-Corporation/ColorPicker/blob/main/CONTRIBUTING.md) to see the full guidelines.
+
+## License
+This project is under the [MIT License](https://github.com/Leo-Corporation/Synethia/blob/main/LICENSE).

Synethia/Synethia/Synethia.csproj

@@ -4,23 +4,23 @@
 	<TargetFramework>net5.0-windows</TargetFramework>
 	<UseWPF>true</UseWPF>
 	<Title>Synethia</Title>
-	<Version>1.0.0.2212</Version>
+	<Version>1.1.0.2301</Version>
 	<Authors>Léo Corporation</Authors>
 	<Description>A basic C# algorithm that can suggest the most relevant pages and actions to a user depending of their behavior with an application.
 </Description>
 	<Copyright>© 2023</Copyright>
 	<PackageProjectUrl>https://github.com/Leo-Corporation/Synethia</PackageProjectUrl>
 	<RepositoryUrl>https://github.com/Leo-Corporation/Synethia</RepositoryUrl>
 	<RepositoryType>git</RepositoryType>
-	<PackageReadmeFile>README.md</PackageReadmeFile>
+	<PackageReadmeFile>NUGET_README.md</PackageReadmeFile>
 	<PackageTags>algorithm;user;experience;ux;user-experience;wpf;windows</PackageTags>
 	<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
 	<PackageIcon>logo.png</PackageIcon>
 	<PackageLicenseExpression>MIT</PackageLicenseExpression>
   </PropertyGroup>
 
   <ItemGroup>
-    <None Include="..\..\README.md">
+    <None Include="..\..\NUGET_README.md">
       <Pack>True</Pack>
       <PackagePath>\</PackagePath>
     </None>

Synethia/Synethia/SynethiaConfig.cs

@@ -22,6 +22,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
 using System.Collections.Generic;
+using System.Linq;
 
 namespace Synethia
 {
@@ -48,5 +49,15 @@ public SynethiaConfig()
 			PagesInfo = new();
 			ActionsInfo = new();
 		}
+
+		/// <summary>
+		/// Gets the most relevant pages.
+		/// </summary>
+		public List<PageInfo> MostRelevantPages => PagesInfo.OrderByDescending(x => x.Score).ToList();
+
+		/// <summary>
+		/// Gets the most relevant actions
+		/// </summary>
+		public List<ActionInfo> MostRelevantActions => ActionsInfo.OrderByDescending(x => x.UsageCount).ToList();
 	}
 }