@mattpolzin/harmony 5.2.0 → 5.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +3 -3
  2. package/harmony +1796 -1455
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -26,7 +26,7 @@ Your Personal Access Token should have the following permissions:
26
26
  - `read:discussion`
27
27
  - `read:enterprise` (Read enterprise profile data)
28
28
 
29
- You can either add the PAT to your environment as the `GITHUB_PAT` variable (perhaps exporting it from your shell resource file or profile) or you can store your PAT in Harmony's config file. The first time you start Harmony, it will ask you to configure your PAT if you don't want to use the Environment variable. You only need one of (a) the ENV var and (b) the config property and the environment variable will take precedence if you have both set.
29
+ You can either add the PAT to your environment as the `GITHUB_PAT` (or alternatively `GH_TOKEN`) variable (perhaps exporting it from your shell resource file or profile) or you can store your PAT in Harmony's config file. The first time you start Harmony, it will ask you to configure your PAT if you don't want to use the Environment variable. You only need one of (a) the ENV var and (b) the config property and the environment variable will take precedence if you have both set.
30
30
 
31
31
  ### NPM
32
32
  You can install Harmony via npm directly by running `npm install -g @mattpolzin/harmony`.
@@ -95,7 +95,7 @@ $ harmony sync
95
95
  Creating a new configuration (storing in harmony.json)...
96
96
 
97
97
  Harmony uses a GitHub Personal Access Token (PAT) to communicate with GitHub.
98
- You can set this via the $GITHUB_PAT environment variable or a config property.
98
+ You can set this via the $GITHUB_PAT or $GH_TOKEN environment variables or a config property.
99
99
  If you don't set in your config now, you can set later with `harmony config githubPAT abcdefg`.
100
100
  The ENV var will always take precedence over the config property.
101
101
 
@@ -128,7 +128,7 @@ Not all configuration properties can be read/set with this command.
128
128
  - `defaultRemote` (optional string) -- When pushing new branches, what remote destination should be used.
129
129
  - `mainBranch` (optional string) -- When creating a PR, this is the default base branch.
130
130
  - `theme` (`dark`/`light`) -- Use colors suited better for either a dark or light Terminal background.
131
- - `githubPAT` (optional string) -- If the `$GITHUB_PAT` environment variable is not set, this Personal Access Token is used to authenticate with GitHub.
131
+ - `githubPAT` (optional string) -- If the `$GITHUB_PAT` and `$GH_TOKEN` environment variables are not set, this Personal Access Token is used to authenticate with GitHub.
132
132
 
133
133
  ### Branch
134
134
  Running `harmony branch` will print the URI for accessing the currently checked out branch on GitHub.