Skip to content

Commit

Permalink
Fix heading level.
Browse files Browse the repository at this point in the history
  • Loading branch information
rogerluan committed Jun 13, 2024
1 parent 08b61f5 commit b1a619b
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,21 +139,21 @@ Usage: arkana [options]
> [!NOTE]
> For the complete set of args, look at the [options](#options) section.
### Config File
## Config File
The `arkana.yml` would typically contain 3 important sections:
- **Environments**: This is typically where you specify `debug`, `release` or other environments which you wish to create.
- **Environment Secrets**: This is where you declare the keys which will be ultimately exposed to your app, like `apiKey`.
- **Global Secrets**: Here you'd declare keys which are the same across all environments.
### Environment File
## Environment File
The environment (`.env`) file contains the actual secrets for each environment. While config file declares the keys, they are assigned encrypted values from this file.
This file is optional, but quite handy in local development. `.env` files shouldn't be committed as they contain your secrets. Instead, they should be stored in a secure location, like your CI/CD server as environment variables (all CI/CD servers have a way to store secrets securely). See [Continuous Integration](#continuous-integration) for more information.
#### Sample
### Sample
A config file as shown below:
Expand Down

0 comments on commit b1a619b

Please sign in to comment.