diff --git a/README.md b/README.md index d5bafcc..8a5feb6 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,12 @@ Alternatively, you can use an environment variable: GITHUB_TOKEN="" gama ``` +You can also make it an alias for a better experience: + +```bash +alias gama='GITHUB_TOKEN="" command gama' +``` + If you have the [GitHub CLI](https://cli.github.com/) installed, you automatically insert the var via: ```bash @@ -56,6 +62,11 @@ GITHUB_TOKEN="$(gh auth token)" gama This will skip needing to generate a token via the GitHub website. +> [!WARNING] +> For security reasons, you should not `export` your token globally in your shell. +> That would make it available to any app that can read environment variables. +> You should avoid committing it to your dotfiles repository, too. + ## Build & Installation ### Using Docker