📝 README cleanup (#5)

igotinfected · May 29, 2023 · 66f7c5c · 66f7c5c
1 parent c829fae
commit 66f7c5c
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 72 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # MatomoProvider
 
-<p style="text-align: center;">
+<p align="center">
     <a href="https://www.nuget.org/packages/MatomoProvider/"><img alt="Nuget" src="https://img.shields.io/nuget/v/MatomoProvider?style=for-the-badge" /></a>
     <img alt="GitHub Workflow Status (with branch)" src="https://img.shields.io/github/actions/workflow/status/igotinfected/MatomoProvider/build-and-test.yml?branch=main&label=build%20%26%20test&style=for-the-badge" />
 </p>
@@ -9,60 +9,14 @@
 
 This component is based on [cmoissl's `Blazor.Matomo`](https://github.com/cmoissl/Blazor.Matomo) component but adapted to provide extra functionality, with a focus on Blazor WASM's SPA nature.
 
-Some of the recommendations from [Matomo's SPA tracking documentation](https://developer.matomo.org/guides/spa-tracking) has been applied to allow proper page, page title, referrer URL, and user id tracking. Other features may follow.
+Some of the recommendations from [Matomo's SPA tracking documentation](https://developer.matomo.org/guides/spa-tracking) have been applied to allow proper page, page title, referrer URL, and user id tracking. Other features may follow.
 
-## Usage
-
-Install the [MatomoProvider](https://www.nuget.org/packages/MatomoProvider/) package.
-
-### Registering the component
-
-The recommended way to use `MatomoProvider` is to add it to the bottom of your `App.razor` file:
-
-```diff
- <Router AppAssembly="@typeof(App).Assembly">
-     ...
- </Router>
-
-+@* Register matomo provider application-wide *@
-+<MatomoProvider ApiUrl="@_matomoOptions.ApiUrl"
-+                SiteId="@_matomoOptions.SiteId"
-+                UserIdFunc="async () => await Task.FromResult(Guid.NewGuid().ToString())" />
-
- @code {
-
-     [Inject]
-     private MatomoOptions _matomoOptions { get; set; } = default!;
-
- }
-```
-
-You must provide:
-
-- `ApiUrl`: the endpoint at which your Matomo instance is hosted
-- `SiteId`: your Matomo website id
-
-You may provide:
-
-- `UserIdFunc`: a function returning the user id to set for the current user
-
-### Adding the script reference
-
-`MatomoProvider` comes bundled with a Javascript file which needs to be added as a script reference in `wwwroot/index.html` for Blazor WASM and `Pages/_Host.cshtml` for Blazor Server:
-
-```diff
-<body>
-    ...
-
-    <script src="_framework/blazor.server.js"></script>
-+   <script src="_content/MatomoProvider/matomo-provider.js"></script>
-</body>
-```
+More details in the [documentation](./src/MatomoProvider/README.md).
 
 ## Development
 
 For ease of development, a docker image has been provided (`/tools/matomo`) that sets up a `mariadb` and a `matomo` instance.
 
-After starting up this docker image, follow the setup instructions (at http://localhost), this should be limited to pressing "next" until asked to create an admin account.
+After starting up this docker image, follow the setup instructions (at [http://localhost](http://localhost)), this should be limited to pressing "next" until asked to create an admin account.
 
 Once the setup is complete no extra configuration needs to be made, the samples should work as-is.
diff --git a/src/MatomoProvider/MatomoProvider.csproj b/src/MatomoProvider/MatomoProvider.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk.Razor">
+<Project Sdk="Microsoft.NET.Sdk.Razor">
   <PropertyGroup>
     <Authors>Jason Rebelo Neves (igotinfected)</Authors>
     <Description>MatomoProvider is a Blazor component that registers and enables the Matomo Analytics tracking code for you.code for you.</Description>
@@ -7,37 +7,37 @@
 
   <PropertyGroup>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
-  </PropertyGroup>
- 
+  </PropertyGroup>
+
   <PropertyGroup>
     <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
-    <None Include="../../README.md" Pack="true" PackagePath=""/>
+    <None Include="README.md" Pack="true" PackagePath=""/>
   </ItemGroup>
 
-  <PropertyGroup>
-    <TargetFramework>net7.0</TargetFramework>
-    <Nullable>enable</Nullable>
-    <ImplicitUsings>enable</ImplicitUsings>
-  </PropertyGroup>
-
-  <ItemGroup>
-    <SupportedPlatform Include="browser" />
-  </ItemGroup>
-
-  <ItemGroup>
+  <PropertyGroup>
+    <TargetFramework>net7.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <SupportedPlatform Include="browser" />
+  </ItemGroup>
+
+  <ItemGroup>
     <PackageReference Include="DotNet.ReproducibleBuilds" Version="1.1.1">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
-    </PackageReference>
-    <PackageReference Include="Microsoft.AspNetCore.Components.Authorization" Version="7.0.5" />
-    <PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="7.0.5" />
+    </PackageReference>
+    <PackageReference Include="Microsoft.AspNetCore.Components.Authorization" Version="7.0.5" />
+    <PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="7.0.5" />
     <PackageReference Include="MinVer" Version="4.3.0">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
-    </PackageReference>
-  </ItemGroup>
-
-</Project>
+    </PackageReference>
+  </ItemGroup>
+
+</Project>
diff --git a/src/MatomoProvider/README.md b/src/MatomoProvider/README.md
@@ -0,0 +1,50 @@
+`MatomoProvider` is a Blazor component that registers and enables the [Matomo Analytics](https://matomo.org/) tracking code for you.
+
+This component is based on [cmoissl's `Blazor.Matomo`](https://github.com/cmoissl/Blazor.Matomo) component but adapted to provide extra functionality, with a focus on Blazor WASM's SPA nature.
+
+Some of the recommendations from [Matomo's SPA tracking documentation](https://developer.matomo.org/guides/spa-tracking) have been applied to allow proper page, page title, referrer URL, and user id tracking. Other features may follow.
+
+
+### Registering the component
+
+The recommended way to use `MatomoProvider` is to add it to the bottom of your `App.razor` file:
+
+```diff
+ <Router AppAssembly="@typeof(App).Assembly">
+     ...
+ </Router>
+
++@* Register matomo provider application-wide *@
++<MatomoProvider ApiUrl="@_matomoOptions.ApiUrl"
++                SiteId="@_matomoOptions.SiteId"
++                UserIdFunc="async () => await Task.FromResult(Guid.NewGuid().ToString())" />
+
+ @code {
+
+     [Inject]
+     private MatomoOptions _matomoOptions { get; set; } = default!;
+
+ }
+```
+
+You must provide:
+
+- `ApiUrl`: the endpoint at which your Matomo instance is hosted
+- `SiteId`: your Matomo website id
+
+You may provide:
+
+- `UserIdFunc`: a function returning the user id to set for the current user
+
+### Adding the script reference
+
+`MatomoProvider` comes bundled with a Javascript file which needs to be added as a script reference in `wwwroot/index.html` for Blazor WASM and `Pages/_Host.cshtml` for Blazor Server:
+
+```diff
+<body>
+    ...
+
+    <script src="_framework/blazor.server.js"></script>
++   <script src="_content/MatomoProvider/matomo-provider.js"></script>
+</body>
+```