From 24e60e4718dcb81f504cd3587f1e4cee2fe17359 Mon Sep 17 00:00:00 2001 From: Alexey Poltorak Date: Sun, 28 Apr 2024 03:11:31 +0500 Subject: [PATCH] Updated Readme --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..86f80c4d --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +## Project Name +**Abblix OIDC Server** + +## Description +**Abblix OIDC Server** is a robust .NET library that implements the OpenID Connect protocol on the server side. It is designed to meet high standards of flexibility, reusability, and reliability, using well-known software design patterns such as modular and hexagonal architectures. These patterns ensure that different parts of the library can work independently, improving the library's modularity, testability, and maintainability. The library also supports Dependency Injection using the standard .NET DI container, which aids in better organization and management of code. Specifically tailored for seamless integration with ASP.NET WebApi, Abblix OIDC Server employs standard controller classes, binding, and routing mechanisms to simplify the integration of OpenID Connect into your services. + +## How to Build +```shell +# Open a terminal (Command Prompt or PowerShell for Windows, Terminal for macOS or Linux) + +# Ensure Git is installed +# Visit https://git-scm.com to download and install console Git if not already installed + +# Clone the repository +git clone https://github.com/Abblix/Oidc.Server.git + +# Navigate to the project directory +cd Oidc.Server + +# Check if .NET SDK is installed +dotnet --version # Check the installed version of .NET SDK +# Visit the official Microsoft website to install or update it if necessary +# Upgrade your .NET version if required + +# Restore dependencies +dotnet restore + +# Compile the project +dotnet build +``` + +## Getting Started + +To better understand the Abblix OIDC Server product, we strongly recommend visiting our comprehensive [Documentation](https://docs.abblix.com/docs) site. Please explore the [Getting Started Guide](https://docs.abblix.com/docs/getting-started-guide), designed to provide you with all the necessary instructions and tips for a thorough understanding of our solution. + +## Contacts + +For more details about our products, services, or any general information regarding the Abblix OIDC Server, feel free to reach out to us. We are here to provide support and answer any questions you may have. Below are the best ways to contact our team: + +- **Email**: Send us your inquiries or support requests at [support@abblix.com](mailto:support@abblix.com). +- **Website**: Visit the official Abblix OIDC Server page for more information: [Abblix OIDC Server](https://www.abblix.com/abblix-oidc-server). + +We look forward to assisting you and ensuring your experience with our products is successful and enjoyable!