diff --git a/README.md b/README.md index fc90f3a..e5bb59e 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@
[![Status](https://img.shields.io/badge/status-active-success.svg)]() -[![GitHub Issues](https://img.shields.io/github/issues/cotti/MessengerPlusSoundBankExtractor.svg)](https://github.com/cotti/MessengerPlusSoundBankExtractor/issues) -[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/cotti/MessengerPlusSoundBankExtractor.svg)](https://github.com/cotti/MessengerPlusSoundBankExtractor/pulls) +[![GitHub Issues](https://img.shields.io/github/issues/cotti/guestbooky.svg)](https://github.com/cotti/guestbooky/issues) +[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/cotti/guestbooky.svg)](https://github.com/cotti/guestbooky/pulls) [![License](https://img.shields.io/badge/license-AGPLv3-003300.svg)](/LICENSE)
@@ -23,12 +23,15 @@ ## πŸ“ Table of Contents -- [About](#about) -- [Getting Started](#getting_started) -- [Deployment](#deployment) -- [Usage](#usage) -- [Built Using](#built_using) -- [Authors](#authors) + +- [πŸ“ Table of Contents](#-table-of-contents) +- [🧐 About ](#-about-) +- [🏁 Getting Started ](#-getting-started-) +- [πŸ•ΈοΈ Prerequisites](#️-prerequisites) +- [🎈 Usage ](#-usage-) +- [πŸš€ Deployment ](#-deployment-) +- [⛏️ Built Using ](#️-built-using-) +- [✍️ Authors ](#️-authors-) ## 🧐 About @@ -40,7 +43,7 @@ It includes many concepts that are very reasonable to tinker with as learning ma These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system. -### Prerequisites +## πŸ•ΈοΈ Prerequisites - .NET 8.0 - A running instance of MongoDB @@ -59,6 +62,7 @@ You will be able to see in `build/docker-compose.public.yml` that the applicatio - CLOUDFLARE_SECRET=0x000000000000000000000000000000000 - MONGODB_CONNECTIONSTRING=mongodb://mongouser:mongopass@mongo:27017/Guestbooky - MONGODB_DATABASENAME=Guestbooky + - LOG_LEVEL=Debug ``` You will need to set them up either by hand or by using your IDE's capabilities. On Visual Studio, that can be done via the Debug Properties of Guestbooky.API. @@ -69,6 +73,8 @@ You will need to set them up either by hand or by using your IDE's capabilities. **MONGODB_\*** -> Related to the connection to MongoDB. Yeah. +**LOG_\*** -> Logging. + ## 🎈 Usage For local usage of the backend, you can use `docker-compose.local.yml` and edit the fields you need.