docs: update readme

README.md

@@ -1,6 +1,111 @@
-# Insallation
-- Build project with `dotnet build`.
-- Add `<Repo_Dir_Path>\src\nArchGen\ConsoleUI\bin\Debug\net6.0` path to your operation system system enviroments.
-# Usage
-- Change directory that in your terminal with project path. Example: `src/rentACar` path.
-- Call CLI with `nArchGen` command.
+<p align="center">
+  <a href="https://github.com/kodlamaio-projects/nArchitecture.Gen/graphs/contributors"><img src="https://img.shields.io/github/contributors/kodlamaio-projects/nArchitecture.Gen.svg?style=for-the-badge"></a>
+  <a href="https://github.com/kodlamaio-projects/nArchitecture.Gen/network/members"><img src="https://img.shields.io/github/forks/kodlamaio-projects/nArchitecture.Gen.svg?style=for-the-badge"></a>
+  <a href="https://github.com/kodlamaio-projects/nArchitecture.Gen/stargazers"><img src="https://img.shields.io/github/stars/kodlamaio-projects/nArchitecture.Gen.svg?style=for-the-badge"></a>
+  <a href="https://github.com/kodlamaio-projects/nArchitecture.Gen/issues"><img src="https://img.shields.io/github/issues/kodlamaio-projects/nArchitecture.Gen.svg?style=for-the-badge"></a>
+  <a href="https://github.com/kodlamaio-projects/nArchitecture.Gen/blob/master/LICENSE"><img src="https://img.shields.io/github/license/kodlamaio-projects/nArchitecture.Gen.svg?style=for-the-badge"></a>
+</p><br />
+
+<p align="center">
+  <a href="https://github.com/kodlamaio-projects/nArchitecture.Gen"><img src="https://user-images.githubusercontent.com/53148314/194872467-827dc967-acee-4bca-88a2-59ed5695bebf.png" height="125"></a>
+  <h3 align="center">nArchitecture Project Code Generator Tool
+</h3>
+  <p align="center">
+    <!-- PROJECT_DESCRIPTION -->
+    <!-- <br />
+    <a href="https://github.com/kodlamaio-projects/nArchitecture.Gen"><strong>Explore the docs »</strong></a>
+    <br /> -->
+    <!-- <br />
+    <a href="https://github.com/kodlamaio-projects/nArchitecture.Gen">View Demo</a>
+    · -->
+    <a href="https://github.com/kodlamaio-projects/nArchitecture.Gen/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/kodlamaio-projects/nArchitecture.Gen/discussions">Request Feature</a>
+  </p>
+</p>
+
+## 💻 About The Project
+
+As Kodlama.io, we have chosen to unveil examples of finalized projects. Natively integrated with Clean Architecture principles, nArchitecture CLI tool epitomizes cutting-edge development methodologies. This monolithic project incorporates Clean Architecture, CQRS, Advanced Repository patterns, Dynamic Querying capabilities, JWT and OTP authentication mechanisms, Google & Microsoft Auth integration, Role-Based Management systems, Distributed Caching powered by Redis, Logging functionalities leveraging Serilog, Elastic Search functionalities, and a feature-rich Code Generator. By actively contributing, you not only bolster the project but also acquire invaluable insights and expertise.
+
+### Built With
+
+[![](https://img.shields.io/badge/.NET%20Core-512BD4?style=for-the-badge&logo=dotnet&logoColor=white)](https://learn.microsoft.com/tr-tr/dotnet/welcome)
+
+## ⚙️ Getting Started
+
+To get a local copy up and running follow these simple steps.
+
+### Prerequisites
+
+- .NET 8
+
+### Installation
+
+1. Install the tool globally:
+   ```sh
+   dotnet tool install --global Kodlamaio.nArchGen --version 0.1.0
+   ```
+
+
+   You can also install the tool locally in the project:
+   1. Create dotnet tool manifest:
+   ```sh
+   dotnet new tool-manifest
+   ```
+   2. Install the tool locally:
+   ```sh
+   dotnet tool install Kodlamaio.nArchGen --version 0.1.0
+   ```
+## 🚀 Usage
+
+1. Run `nArchGen` command in project solution directory.
+
+## 🚧 Roadmap
+
+See the [open issues](https://github.com/kodlamaio-projects/nArchitecture.Gen/issues) for a list of proposed features (and known issues).
+
+## 🤝 Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the project and clone your local machine
+2. Create your Feature Branch:
+    ```sh 
+    git checkout -b <Feature>/<AmazingFeature>
+    ```
+3. Develop
+4. Commit your Changes:
+    ```sh
+    git add . && git commit -m '<SemanticCommitType>(<Scope>): <AmazingFeature>'
+    ```
+   💡 Check [Semantic Commit Messages](./docs/Semantic%20Commit%20Messages.md).
+
+   💡 You can also use [Commitizen CLI](https://github.com/commitizen/cz-cli).
+
+5. Push to the Branch:
+   ```sh
+   git push origin <Feature>/<AmazingFeature>
+   ```
+6. Open a Pull Request
+
+### Analysis
+
+1. If not, Install dotnet tool `dotnet tool restore`.
+2. Run anaylsis command `dotnet roslynator analyze`
+
+### Format
+
+1. If not, Install dotnet tool `dotnet tool restore`.
+2. Run format command `dotnet csharpier .`
+
+## ⚖️ License
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+## 📧 Contact
+
+**Project Link:** [https://github.com/kodlamaio-projects/nArchitecture.Gen](https://github.com/kodlamaio-projects/nArchitecture.Gen)
+
+<!-- ## 🙏 Acknowledgements
+- []() -->