Feature/#99 change org name (#135)

* #99 update packages * #99 update nextbix to itbackyard * Update coverage badge * #99 edit text * #99 doc clean up * #99 improve naming * #99 improvment * #99 doc updater * #99 update --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
itbackyard · Dec 29, 2024 · 7c99c57 · 7c99c57
1 parent adb9861
commit 7c99c57
Show file tree

Hide file tree

Showing 26 changed files with 333 additions and 77 deletions.
diff --git a/CryptoNet.ExtPack/CryptoNet.ExtPack.csproj b/CryptoNet.ExtPack/CryptoNet.ExtPack.csproj
@@ -14,7 +14,7 @@
     <ApplicationIcon>CryptoNetLogo-icon.ico</ApplicationIcon>
     <PackageIcon>CryptoNetLogo-icon.png</PackageIcon>
     <PackageIconUrl>https://raw.githubusercontent.com/maythamfahmi/CryptoNet/main/img/CryptoNetLogo-icon.png</PackageIconUrl>
-    <Company>NextBix</Company>
+    <Company>itbackyard</Company>
     <Authors>Maytham Fahmi</Authors>
     <MinClientVersion>1.0.0</MinClientVersion>
     <Version>3.0.0</Version>

diff --git a/CryptoNet.ExtShared/CryptoNet.ExtShared.csproj b/CryptoNet.ExtShared/CryptoNet.ExtShared.csproj
@@ -8,7 +8,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
-    <PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="8.0.0" PrivateAssets="All" />
+    <PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="9.0.0" PrivateAssets="All" />
     <PackageReference Include="System.Text.Json" Version="8.0.5" />
   </ItemGroup>
 

diff --git a/CryptoNet.ExtShared/ExtShared.cs b/CryptoNet.ExtShared/ExtShared.cs
@@ -1,4 +1,4 @@
-// <copyright file="CryptoNetUtils.cs" company="NextBix" year="2021">
+// <copyright file="CryptoNetUtils.cs" company="itbackyard" year="2021">
 // Copyright (c) 2021 All Rights Reserved
 // </copyright>
 // <author>Maytham Fahmi</author>

diff --git a/CryptoNet.Models/CryptoNetInfo.cs b/CryptoNet.Models/CryptoNetInfo.cs
@@ -1,4 +1,4 @@
-// <copyright file="CryptoNetInfo.cs" company="NextBix" year="2021">
+// <copyright file="CryptoNetInfo.cs" company="itbackyard" year="2021">
 // Copyright (c) 2021 All Rights Reserved
 // </copyright>
 // <author>Maytham Fahmi</author>

diff --git a/CryptoNet.UnitTests/CryptoNet.UnitTests.csproj b/CryptoNet.UnitTests/CryptoNet.UnitTests.csproj
@@ -16,15 +16,15 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
     <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Core" Version="8.0.7" />
     <PackageReference Include="Moq" Version="4.20.72" />
-    <PackageReference Include="NUnit" Version="4.2.2" />
+    <PackageReference Include="NUnit" Version="4.3.2" />
     <PackageReference Include="NUnit3TestAdapter" Version="4.6.0" />
     <PackageReference Include="coverlet.collector" Version="6.0.2">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="ReportGenerator" Version="5.4.1" />
+    <PackageReference Include="ReportGenerator" Version="5.4.3" />
     <PackageReference Include="Shouldly" Version="4.2.1" />
-    <PackageReference Include="SharperHacks.CoreLibs.IO" Version="5.0.1" />
+    <PackageReference Include="SharperHacks.CoreLibs.IO" Version="5.0.2" />
     <PackageReference Include="System.Text.Json" Version="8.0.5" />
   </ItemGroup>
 

diff --git a/CryptoNet.UnitTests/CryptoNetAesTests.cs b/CryptoNet.UnitTests/CryptoNetAesTests.cs
@@ -1,4 +1,4 @@
-// <copyright file="CryptoNetTests.cs" company="NextBix" year="2021">
+// <copyright file="CryptoNetTests.cs" company="itbackyard" year="2021">
 // Copyright (c) 2021 All Rights Reserved
 // </copyright>
 // <author>Maytham Fahmi</author>

diff --git a/CryptoNet.UnitTests/CryptoNetDsaTests.cs b/CryptoNet.UnitTests/CryptoNetDsaTests.cs
@@ -1,4 +1,4 @@
-// <copyright file="CryptoNetDsaTests.cs" company="NextBix" year="2024">
+// <copyright file="CryptoNetDsaTests.cs" company="itbackyard" year="2024">
 // Copyright (c) 2021 All Rights Reserved
 // </copyright>
 // <author>Maytham Fahmi</author>

diff --git a/CryptoNet.UnitTests/CryptoNetRsaTests.cs b/CryptoNet.UnitTests/CryptoNetRsaTests.cs
@@ -1,4 +1,4 @@
-// <copyright file="CryptoNetTests.cs" company="NextBix" year="2021">
+// <copyright file="CryptoNetTests.cs" company="itbackyard" year="2021">
 // Copyright (c) 2021 All Rights Reserved
 // </copyright>
 // <author>Maytham Fahmi</author>

diff --git a/CryptoNet/CryptoNet.csproj b/CryptoNet/CryptoNet.csproj
@@ -12,7 +12,7 @@
     <ApplicationIcon>CryptoNetLogo-icon.ico</ApplicationIcon>
     <PackageIcon>CryptoNetLogo-icon.png</PackageIcon>
     <PackageIconUrl>https://raw.githubusercontent.com/maythamfahmi/CryptoNet/main/img/CryptoNetLogo-icon.png</PackageIconUrl>
-    <Company>NextBix</Company>
+    <Company>itbackyard</Company>
     <Authors>Maytham Fahmi</Authors>
     <MinClientVersion>1.0.0</MinClientVersion>
     <Version>3.0.0</Version>
@@ -46,7 +46,7 @@
       <CopyToOutputDirectory>Never</CopyToOutputDirectory>
     </Content>
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
-    <PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="8.0.0" PrivateAssets="All" />
+    <PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="9.0.0" PrivateAssets="All" />
     <PackageReference Include="System.Text.Json" Version="8.0.5" />
   </ItemGroup>
 

diff --git a/CryptoNet/CryptoNetAes.cs b/CryptoNet/CryptoNetAes.cs
@@ -1,4 +1,4 @@
-// <copyright file="CryptoNetAes.cs" company="NextBix" year="2021">
+// <copyright file="CryptoNetAes.cs" company="itbackyard" year="2021">
 // Copyright (c) 2021 All Rights Reserved
 // </copyright>
 // <author>Maytham Fahmi</author>

diff --git a/CryptoNet/CryptoNetRsa.cs b/CryptoNet/CryptoNetRsa.cs
@@ -1,4 +1,4 @@
-// <copyright file="CryptoNetRsa.cs" company="NextBix" year="2021">
+// <copyright file="CryptoNetRsa.cs" company="itbackyard" year="2021">
 // Copyright (c) 2021 All Rights Reserved
 // </copyright>
 // <author>Maytham Fahmi</author>

diff --git a/CryptoNet/ICryptoNet.cs b/CryptoNet/ICryptoNet.cs
@@ -1,4 +1,4 @@
-// <copyright file="ICryptoNet.cs" company="NextBix" year="2021">
+// <copyright file="ICryptoNet.cs" company="itbackyard" year="2021">
 // Copyright (c) 2021 All Rights Reserved
 // </copyright>
 // <author>Maytham Fahmi</author>

diff --git a/CryptoNet/ICryptoNetAes.cs b/CryptoNet/ICryptoNetAes.cs
@@ -1,4 +1,4 @@
-// <copyright file="ICryptoNetAes.cs" company="NextBix" year="2024">
+// <copyright file="ICryptoNetAes.cs" company="itbackyard" year="2024">
 // Copyright (c) 2021 All Rights Reserved
 // </copyright>
 // <author>Maytham Fahmi</author>

diff --git a/CryptoNet/ICryptoNetDsa.cs b/CryptoNet/ICryptoNetDsa.cs
@@ -1,4 +1,4 @@
-// <copyright file="ICryptoNetDsa.cs" company="NextBix" year="2024">
+// <copyright file="ICryptoNetDsa.cs" company="itbackyard" year="2024">
 // Copyright (c) 2021 All Rights Reserved
 // </copyright>
 // <author>Maytham Fahmi</author>

diff --git a/CryptoNet/ICryptoNetRsa.cs b/CryptoNet/ICryptoNetRsa.cs
@@ -1,4 +1,4 @@
-// <copyright file="ICryptoNetRsa.cs" company="NextBix" year="2024">
+// <copyright file="ICryptoNetRsa.cs" company="itbackyard" year="2024">
 // Copyright (c) 2021 All Rights Reserved
 // </copyright>
 // <author>Maytham Fahmi</author>

diff --git a/Examples/Examples.UnitTests/Examples.UnitTests.csproj b/Examples/Examples.UnitTests/Examples.UnitTests.csproj
@@ -14,7 +14,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="CliWrap" Version="3.6.7" />
+    <PackageReference Include="CliWrap" Version="3.7.0" />
     <PackageReference Include="coverlet.collector" Version="6.0.2">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
@@ -24,13 +24,13 @@
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
-    <PackageReference Include="NUnit" Version="4.2.2" />
-    <PackageReference Include="NUnit.Analyzers" Version="4.4.0">
+    <PackageReference Include="NUnit" Version="4.3.2" />
+    <PackageReference Include="NUnit.Analyzers" Version="4.5.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <PackageReference Include="NUnit3TestAdapter" Version="4.6.0" />
-    <PackageReference Include="SharperHacks.CoreLibs.IO" Version="5.0.1" />
+    <PackageReference Include="SharperHacks.CoreLibs.IO" Version="5.0.2" />
     <PackageReference Include="System.Text.Json" Version="8.0.5" />
   </ItemGroup>
 

diff --git a/README.md b/README.md
@@ -24,13 +24,18 @@ https://maythamfahmi.github.io/CryptoNet
 
 [![Nuget](https://img.shields.io/nuget/v/cryptonet?style=social)](https://www.nuget.org/packages/CryptoNet/) is latest version and are maintained. 
 
-List of features:
-- RSA asymmetric encryption.
-- AES symmetric encryption.
+CryptoNet v3:
+
+- RSA: Asymmetric cryptographic algorithm used for secure data transmission and digital signatures.
+- AES: Symmetric cryptographic algorithm used for fast and secure data encryption.
+- DSA: Asymmetric cryptographic algorithm used for digital signatures
+
+CryptoNet Extensions v3:
+
 - RSA PEM exporting and importing.
 - Support for X509Certificate2.
-- Ability to encrypt and decrypt text, and files like images, word, excel, etc.
-- Cross-platform compatible with Windows, Linux, and iOS.
+- Ability to encrypt and decrypt text, and files like images, word, excel, and any byte content.
+- **Cross-platform compatible** with Windows, Linux, and iOS.
 
 ## Issues
 
@@ -51,6 +56,12 @@ You have different options to build and run the unit tests from:
 docker build . --file .\Dockerfile --tag cryptonet-service:latest
 ```
 
+or run preserved PowerShell:
+
+```powershell
+./run_docker_build.ps1
+```
+
 ## How to release a new version?
 
 Preview
@@ -63,6 +74,95 @@ Release
 .\Release.ps1 -VersionNumber 3.0.0 -IsPreview $false
 ```
 
+## Documentation Creation
+
+There are static and dynamically generated documentation. Both are published automatically in the pipeline called `5-static.yml`.
+
+To work with the documentation locally, the following might be relevant:
+
+- **Static base documentation** is located in the `docs` folder.
+- **Dynamically generated documentation** is created from code using a tool called **DocFX**.
+
+### Running Documentation Creation Locally
+
+To generate the documentation locally on your computer, run:
+
+```powershell
+.\run_docs.ps1
+```
+
+### Setup
+
+1. Install the DocFX tool (only needs to be done once):
+
+```
+dotnet tool install -g docfx
+```
+
+2. The following step is already configured in this repository. However, if you need to start over, run the following to initialize and configure DocFX:
+
+```
+docfx init -y
+```
+
+## Update `index.md` with `README.md`
+
+To update `index.md` with the latest content from `README.md`, run the following command:
+
+```powershell
+./run_update_index.ps1
+```
+This script will:
+
+1. Add the following header to the top of `index.md`:
+
+```yaml
+---
+_layout: landing
+---
+```
+
+2. Append the content of `README.md` to `index.md`.
+
+This ensures that index.md is always up to date with the latest changes in `README.md`.
+
+## Code Coverage
+
+Code coverage ensures that your tests adequately cover your codebase, improving overall quality, reliability, and maintainability. Follow these steps to set up and generate code coverage reports.
+
+### Running Code Coverage Locally
+
+To generate code coverage reports locally on your computer, run the following command in Windows:
+
+```powershell
+.\run_codecoverage.ps1
+```
+
+### Setup
+
+If the required tools and packages are not set up locally, follow the steps below to configure them:
+
+1. Navigate to your test project directory (e.g., `CryptoNet.UnitTests`):
+
+```bash
+cd .\CryptoNet.UnitTests\
+```
+
+2. Add the necessary coverage packages to your test project:
+
+```bash
+dotnet add package coverlet.collector
+dotnet add package coverlet.msbuild
+```
+
+3. Install the report generator tool (only needs to be done once):
+
+```bash
+dotnet tool install --global dotnet-reportgenerator-globaltool
+```
+
+Once set up, you can use these tools to analyze and generate detailed code coverage reports to ensure thorough testing of your application.
+
 ## Contributing
 
 You are more than welcome to contribute in one of the following ways:

diff --git a/coverage-badge.svg b/coverage-badge.svg