diff --git a/README.md b/README.md index f8fd4b16..60e0a361 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,7 @@ To obtain the Jenkins API token token in the inbox that appears, and click `GENERATE`. 4. Copy the generated token. 5. Add it into your `ncurc` file (`~/.ncurc` or `$XDG_CONFIG_HOME/ncurc`) - with `jenkins_token` as key, like this + with `jenkins_token` as key, like this: ```json { @@ -113,7 +113,9 @@ To obtain the Jenkins API token ### Make sure your credentials won't be committed -Put the following entries into `~/.gitignore_global` +Put the following entries into your +[global `gitignore` file](https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreexcludesFile) +(`$XDG_CONFIG_HOME/git/ignore` or a file specified by `core.excludesFile`): ``` # node-core-utils configuration file @@ -122,7 +124,7 @@ Put the following entries into `~/.gitignore_global` .ncu ``` -Mind that`.ncu/land` could contain your access token since it contains the +Mind that `.ncu/land` could contain your access token since it contains the serialized configurations. If you ever accidentally commit your access token on GitHub, you can simply diff --git a/docs/ncu-ci.md b/docs/ncu-ci.md index 423a7b49..6b0c72fe 100644 --- a/docs/ncu-ci.md +++ b/docs/ncu-ci.md @@ -111,7 +111,7 @@ and then cache the responses from Jenkins so that the next time the command is run, it picks up cached data written on disk for jobs whose results are known. -Note: results are cached in `${ncu_intallation_path}/.ncu/cache`, so you +Note: results are cached in `${ncu_installation_path}/.ncu/cache`, so you may want to clean it up from time to time. ```