Merge pull request #18 from gsilvamartin/13-add-usage-guide-to-docume…

…ntation-for-algorithms-converters-generator-and-validator

Add usage guide to documentation for algorithms converters generator and validator

docs/docs/algorithms/getting-started.md

@@ -0,0 +1,105 @@
+# NetPlus.Algorithms
+
+## Overview
+
+The `NetPlus.Algorithms` NuGet package provides a diverse collection of algorithms encapsulated into modular components, offering functionalities for sorting, searching, comparison, and graph-related operations.
+
+## Installation
+
+To harness the power of these algorithms, you have the flexibility to install the entire `NetPlus.Algorithms` library or cherry-pick individual modules based on your project's needs.
+
+### Install the Entire Package
+
+Install the complete `NetPlus.Algorithms` library, which includes a variety of algorithms covering sorting, searching, comparison, and graph-related operations.
+
+Run the following command in the Visual Studio terminal:
+
+```bash
+Install-Package NetPlus.Algorithms
+```
+
+Or, if you're using the .NET Core command-line interface:
+
+```bash
+dotnet add package NetPlus.Algorithms
+```
+
+### Install Individual Modules
+
+Tailor your algorithmic toolkit by selectively installing specific modules.
+
+### Sorting Module
+
+```bash
+Install-Package NetPlus.Algorithms.Sorting
+```
+
+Or using the .NET Core CLI:
+
+```bash
+dotnet add package NetPlus.Algorithms.Sorting
+```
+
+### Search Module
+
+```bash
+Install-Package NetPlus.Algorithms.Search
+```
+
+Or using the .NET Core CLI:
+
+```bash
+dotnet add package NetPlus.Algorithms.Search
+```
+
+### Comparison Module
+
+```bash
+Install-Package NetPlus.Algorithms.Comparison
+```
+
+Or using the .NET Core CLI:
+
+```bash
+dotnet add package NetPlus.Algorithms.Comparison
+```
+
+### Graphs Module
+
+```bash
+Install-Package NetPlus.Algorithms.Graphs
+```
+
+Or using the .NET Core CLI:
+
+```bash
+dotnet add package NetPlus.Algorithms.Graphs
+```
+
+## What is NetPlus.Algorithms?
+
+`NetPlus.Algorithms` is an abstraction of fundamental algorithms used in computer science and software development. It simplifies the integration of powerful algorithms into your projects, promoting code reuse and maintainability.
+
+## Module Details
+
+### Sorting Module
+
+The Sorting module provides various algorithms for sorting arrays in ascending order, including popular algorithms like Bubble Sort, Quick Sort, and Merge Sort.
+
+### Search Module
+
+The Search module equips you with diverse algorithms for searching elements in data structures, including the A* Search algorithm for finding the shortest path in a weighted graph. Other search algorithms include Binary Search and Linear Search.
+
+### Comparison Module
+
+The Comparison module introduces algorithms for measuring the similarity between strings. It includes the implementation of the Cosine Similarity algorithm and other string comparison utilities.
+
+### Graphs Module
+
+The Graphs module offers algorithms for graph-related operations, including the Breadth-First Search algorithm for traversing graphs. Other graph algorithms, such as Depth-First Search and Dijkstra's Algorithm, are also included.
+
+## Note
+
+Ensure that you have the appropriate package source configured in your NuGet package manager. If you're using a private repository, make sure to add the source before attempting to install the packages.
+
+Leverage the entire `NetPlus.Algorithms` package for a robust set of algorithms or choose specific modules that align with your project requirements. These algorithms are designed to enhance the efficiency and functionality of your applications, serving as a valuable asset in various computational scenarios.

docs/docs/converters/getting-started.md

@@ -0,0 +1,55 @@
+# NetPlus.Converter
+
+## Overview
+
+The `NetPlus.Converter` NuGet package offers a versatile set of static classes providing extension methods and functions for converting various units. In this documentation, we'll explore two primary modules: `DateTimeConverter` and `TemperatureConverter`.
+
+## Installation
+
+You can choose to install the complete `NetPlus.Converter` library or specific modules based on your project requirements.
+
+### Install the Entire Package
+
+Install the complete `NetPlus.Converter` library, which includes multiple modules for different conversion functionalities.
+
+```bash
+Install-Package NetPlus.Converter
+```
+
+Or, using the .NET Core CLI:
+
+```bash
+dotnet add package NetPlus.Converter
+```
+
+### Install Individual Modules
+
+Tailor your unit conversion toolkit by selectively installing specific modules.
+
+#### DateTimeConverter Module
+
+```bash
+Install-Package NetPlus.Converter.DateTime
+```
+
+Or using the .NET Core CLI:
+
+```bash
+dotnet add package NetPlus.Converter.DateTime
+```
+
+#### TemperatureConverter Module
+
+```bash
+Install-Package NetPlus.Converter.Temperature
+```
+
+Or using the .NET Core CLI:
+
+```bash
+dotnet add package NetPlus.Converter.Temperature
+```
+
+## What is NetPlus.Converter?
+
+`NetPlus.Converter` is a collection of static classes providing extension methods and functions for seamless unit conversion, offering flexibility and ease of integration into your projects.

docs/docs/generators/getting-started.md

@@ -0,0 +1,87 @@
+# NetPlus.Generator
+
+## Overview
+
+The `NetPlus.Generator` NuGet package is a powerful toolset for generating random data, GUIDs, and passwords in your applications. This library includes modules for data generation, GUID generation, and password generation, providing flexible and efficient utilities.
+
+## Installation
+
+You can install the entire `NetPlus.Generator` package or choose specific modules to meet your project requirements.
+
+### Install the Entire Package
+
+To install the complete `NetPlus.Generator` library, which includes data generation, GUID generation, and password generation modules, use the following command in the Visual Studio terminal:
+
+```bash
+Install-Package NetPlus.Generator
+```
+
+If you're using the .NET Core command-line interface:
+
+```bash
+dotnet add package NetPlus.Generator
+```
+
+### Install Individual Modules
+
+Tailor your data generation toolkit by selectively installing specific modules.
+
+#### Data Generation Module
+
+```bash
+Install-Package NetPlus.Generator.Data
+```
+
+Or using the .NET Core CLI:
+
+```bash
+dotnet add package NetPlus.Generator.Data
+```
+
+#### GUID Generation Module
+
+```bash
+Install-Package NetPlus.Generator.Guid
+```
+
+Or using the .NET Core CLI:
+
+```bash
+dotnet add package NetPlus.Generator.Guid
+```
+
+#### Password Generation Module
+
+```bash
+Install-Package NetPlus.Generator.Password
+```
+
+Or using the .NET Core CLI:
+
+```bash
+dotnet add package NetPlus.Generator.Password
+```
+
+## What is NetPlus.Generator?
+
+`NetPlus.Generator` simplifies the task of generating random data, GUIDs, and passwords in your applications. Whether you need to populate test data, create unique identifiers, or enhance security with robust passwords, this library provides efficient and reliable solutions.
+
+## Module Details
+
+### Data Generation Module
+
+The Data Generation module includes a `DataGenerator` class with methods for generating random data of specified types. It uses reflection to create instances with random property values.
+
+### GUID Generation Module
+
+The GUID Generation module introduces a `GuidGenerator` class offering methods for generating new GUIDs in various formats, including string, byte array, and Base64 string.
+
+### Password Generation Module
+
+The Password Generation module provides a `PasswordGenerator` class with methods for generating random passwords. You can customize the length, allowed characters, and the number of non-alphanumeric characters in the generated passwords.
+
+## Note
+
+Ensure that you have the appropriate package source configured in your NuGet package manager. If you're using a private repository, make sure to add the source before attempting to install the packages.
+
+Select the entire `NetPlus.Generator` package for a comprehensive set of generation tools, or choose specific modules based on your application's needs. These generation utilities add versatility to your code, addressing common scenarios that require random data, GUIDs, or secure passwords.

docs/docs/toc.yml

@@ -6,6 +6,8 @@
 - name: NetPlus Modules
 - name: Algorithms
   items:
+    - name: Introduction
+      href: algorithms/getting-started.md
     - name: Comparison
       items:
         - name: CosineSimilarity
@@ -56,6 +58,8 @@
 
 - name: Converters
   items:
+    - name: Introduction
+      href: converters/getting-started.md
     - name: Date
       items:
         - name: DateTimeConverter
@@ -68,6 +72,9 @@
 
 - name: Generators
   items:
+    - name: Introduction
+      href: generators/getting-started.md
+
     - name: GenericGenerator
       items:
         - name: DataGenerator
@@ -85,6 +92,9 @@
 
 - name: Validators
   items:
+    - name: Introduction
+      href: validators/getting-started.md
+
     - name: Date
       items:
         - name: DateValidator

docs/docs/validators/getting-started.md

@@ -0,0 +1,87 @@
+# NetPlus.Validators
+
+## Overview
+
+The `NetPlus.Validators` NuGet package provides versatile validation utilities for strings, numerics, and dates, encapsulated into modular components. These utility classes include `StringValidator`, `NumericValidator`, and `DateValidator`, each offering a set of methods to validate and check various properties of the input values.
+
+## Installation
+
+Install the complete `NetPlus.Validators` library or select individual modules based on your validation needs.
+
+### Install the Entire Package
+
+To install the complete `NetPlus.Validators` library, including string, numeric, and date validation modules, use the following command in the Visual Studio terminal:
+
+```bash
+Install-Package NetPlus.Validators
+```
+
+If you're using the .NET Core command-line interface:
+
+```bash
+dotnet add package NetPlus.Validators
+```
+
+### Install Individual Modules
+
+Choose specific validation modules to integrate into your project.
+
+#### String Validation Module
+
+```bash
+Install-Package NetPlus.Validators.Strings
+```
+
+Or using the .NET Core CLI:
+
+```bash
+dotnet add package NetPlus.Validators.Strings
+```
+
+#### Numeric Validation Module
+
+```bash
+Install-Package NetPlus.Validators.Numerics
+```
+
+Or using the .NET Core CLI:
+
+```bash
+dotnet add package NetPlus.Validators.Numerics
+```
+
+#### Date Validation Module
+
+```bash
+Install-Package NetPlus.Validators.Dates
+```
+
+Or using the .NET Core CLI:
+
+```bash
+dotnet add package NetPlus.Validators.Dates
+```
+
+## What is NetPlus.Validators?
+
+`NetPlus.Validators` simplifies the process of validating strings, numerics, and dates in your applications. These utility classes provide methods to check various properties, enhancing the reliability and accuracy of your input data validation.
+
+## Module Details
+
+### String Validation Module
+
+The `StringValidator` class includes methods like `IsDate`, `IsDateTime`, and `IsUnicode` to check specific properties of strings. Additionally, it offers methods like `IsEmail`, `IsUrl`, `IsPhoneNumber`, and `IsPostalCode` for extended string validation.
+
+### Numeric Validation Module
+
+The `NumericValidator` class provides methods such as `IsPositive`, `IsNegative`, and `IsZero` to validate numeric values. Other methods like `IsEven`, `IsOdd`, `IsBetween`, and `IsPrime` offer diverse numeric validation options.
+
+### Date Validation Module
+
+The `DateValidator` class offers methods like `IsDate`, `IsFutureDate`, `IsPastDate`, and `IsLeapYear` for validating dates. It includes numerous other methods for specific date checks, ensuring the accuracy of date-related input.
+
+## Note
+
+Ensure that you have the appropriate package source configured in your NuGet package manager. If you're using a private repository, make sure to add the source before attempting to install the packages.
+
+Choose the entire `NetPlus.Validators` package for a comprehensive set of validation tools, or select individual modules based on your application's specific validation requirements. These utility classes are designed to simplify and enhance the validation process in your .NET projects.