Skip to content

Commit

Permalink
Update README.md (#2)
Browse files Browse the repository at this point in the history
Some README polish and give example connection string.
  • Loading branch information
paulirwin authored Jan 11, 2024
1 parent af05fc6 commit cc140f7
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
# Emulator for Azure App Configuration
# Azure App Configuration Emulator

Please note that Emulator for Azure App Configuration is unofficial and not endorsed by Microsoft.
Please note that this project is unofficial and not endorsed by Microsoft.
It is not intended for production use.

## Getting Started

Clone the repo and run from the root of the project:

```shell
docker-compose up -d
```

(Leave off the `-d` to run in your current terminal instead of in background/detached mode.)

Use the following connection string to connect to the emulator:

`Endpoint=http://localhost:18080;Id=abcd;Secret=c2VjcmV0`

### Local development

1. Run `./keygen.sh` to generate the HTTPS keypair (Linux/macOS/WSL; Windows instructions TODO)
2. Run `dotnet run` from the `src/AzureAppConfigurationEmulator` folder, or start the app from your IDE
2. Run `dotnet run` from the `src/AzureAppConfigurationEmulator` folder, or start the app from your IDE, adjusting the port in the connection string

## Authentication

Expand Down

0 comments on commit cc140f7

Please sign in to comment.