Skip to content

Commit

Permalink
Mention that .cloak directory is relate to working directory when run…
Browse files Browse the repository at this point in the history
…ning commands
  • Loading branch information
lordcodes committed Jul 6, 2022
1 parent 2b1374b commit 3c2b2a5
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ The best practice is that the values should be encrypted first.

### 🖥 Via the Tuist Plugin

Run Cloak's tasks via Tuist.
Run Cloak's tasks via Tuist. The tool will check paths relative to the working directory for the `.cloak` directory configured above.

```terminal
USAGE: tuist cloak <subcommand> [-q|--quiet]
Expand Down Expand Up @@ -165,6 +165,8 @@ Generate a Swift file that can be used to access your secrets within your app at

### 🖥 Via the Standalone CLI

Run Cloak's tasks via a standalone executable. The tool will check paths relative to the working directory for the `.cloak` directory configured above.

```terminal
USAGE: cloakswift <subcommand> [-q|--quiet]
```
Expand Down
1 change: 0 additions & 1 deletion Sources/CloakKit/Configuration/EnvironmentKey.swift
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

import Foundation

// TODO: Document environment keys and config file keys in README
enum EnvironmentKey: String {
case encryptionKey = "CLOAK_ENCRYPTION_KEY"
case secretsClassName = "CLOAK_SECRETS_CLASS_NAME"
Expand Down

0 comments on commit 3c2b2a5

Please sign in to comment.