From 3c2b2a500df7c3bf60726f7125186fabaf6c05dc Mon Sep 17 00:00:00 2001 From: Andrew Lord Date: Wed, 6 Jul 2022 17:31:21 +0100 Subject: [PATCH] Mention that .cloak directory is relate to working directory when running commands --- README.md | 4 +++- Sources/CloakKit/Configuration/EnvironmentKey.swift | 1 - 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7f98c27..9262977 100644 --- a/README.md +++ b/README.md @@ -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 [-q|--quiet] @@ -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 [-q|--quiet] ``` diff --git a/Sources/CloakKit/Configuration/EnvironmentKey.swift b/Sources/CloakKit/Configuration/EnvironmentKey.swift index a4a2f85..92ced44 100644 --- a/Sources/CloakKit/Configuration/EnvironmentKey.swift +++ b/Sources/CloakKit/Configuration/EnvironmentKey.swift @@ -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"