Skip to content

Commit

Permalink
updated some comments and README
Browse files Browse the repository at this point in the history
  • Loading branch information
Foat committed May 23, 2024
1 parent 1e66162 commit f3a69e2
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The script uses a JSON configuration file to specify the dotfiles setup. Here is

### Running the Script

To use the dotfiles manager, run the script with the desired options:
To use kdf, run the script with the desired options:

```bash
python kdf.py --config path/to/config.json [--dry-run] [--check-templates]
Expand Down Expand Up @@ -92,7 +92,7 @@ cd .dotfiles
See `./example/run.sh` for some comments on how to use environment variables.

### Template Variables
In template files, replaceable variables are presented like `{{ TEMP_BW_SESSION }}`. The program will replace these variables with the corresponding environment variable values. You can provide variables in base64 format (used for multiline variables); use the `env_base64` config parameter for that. It will be decoded before replacing the template variable.
In template files, replaceable variables are presented like `{{ TEMP_BW_SESSION }}`. The program will replace these variables with the corresponding environment variable values. You can provide variables in base64 format (used for multiline variables); use the `env_base64` config parameter for that. They will be decoded before replacing the template variables.

## Requirements

Expand Down
2 changes: 1 addition & 1 deletion example/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ set -euo pipefail
IFS=$'\n\t'

# I prefer to store all secrets on a self-hosted Bitwarden server.
# Below is an example of how to do that.
# Below is an example of how to get environment variables from the Bitwarden CLI.
# For the ability to work with JSON (Bitwarden CLI output), you need to have the `jq` CLI installed on your system.

# set -eo pipefail
Expand Down

0 comments on commit f3a69e2

Please sign in to comment.