@mattpolzin/harmony 4.1.0 → 4.4.0

package/README.md

@@ -46,6 +46,11 @@ You can add Harmony to your Flake inputs as follows:
 
 Then, in your outputs, bring Harmony into a package install list as `harmony.packages.<system>.harmony`.
 
+Harmony builds are cached in Cachix so you can take advantage of those builds by
+adding `gh-harmony.cachix.org` to the list of `substituters` and
+`gh-harmony.cachix.org-1:KX5tTtEt3Y6an8pywe3Cy6jR9bUo+1Cl7hJmh+5eI4I=` to the
+list of `trusted-public-keys`.
+
 ### From Source
 The build script assumes a HEAD build of Idris 2 is installed on your system. For an alternative, see the [Docker Build](#docker-build) instructions below.
 
@@ -84,7 +89,7 @@ eval "$(harmony --zsh-completion-script)"
 ## Usage
 The first time you start Harmony in any particular folder, you will be asked to provide some information about the GitHub repository you are working with. This information is stored in a file named `harmony.json` in the current working directory.
 
-Note that the GitHub organization and repository are both slugs, not names. These are the values you find in a GitHub URL pointing to your repository. Harmony does not work with personal repositories because they do not have teams or members.
+Note that the GitHub organization and repository are both slugs, not names. These are the values you find in a GitHub URL pointing to your repository. Harmony works with personal repositories but some of Harmony's features are not available for these repos because they do not have teams or members.
 ```
 $ harmony sync
 Creating a new configuration (storing in harmony.json)...
@@ -107,7 +112,10 @@ Would you like harmony to request team reviews in addition to individuals when i
 Creating config...
 ```
 
-Once configured, Harmony supports the following commands: `config`, `branch`, `pr`, `label`, `request`, `contribute`, `whoami`, `reflect`, `list`, `graph`, `health`, and `sync`.
+Once configured, Harmony supports the following commands: `config`, `branch`, `pr`, `label`, `request` (also aliased to `rq`), `contribute`, `whoami`, `reflect`, `list`, `graph`, `health`, and `sync`.
+
+**Note on color output:**
+Harmony uses colored output for some commands. You can adjust these colors slightly with the `theme` configuration option. You can also use the `NO_COLOR` environment variable to disable all colored output. Lastly, Harmony will avoid colored output when it determines `stdout` is not a TTY device (as is the case for e.g. redirecting harmony output into a file or piping into `cat`: `harmony ... | cat`).
 
 ### Config
 Running `harmony config <property>` will read the given configuration property. `harmony config <property> <value>` will set the configuration property.
@@ -118,6 +126,8 @@ Not all configuration properties can be read/set with this command.
 - `requestUsers` (`true`/`false`) -- When requesting a team as a reviewer, pick a user to review as well.
 - `commentOnRequest` (`true`/`false`) -- When requesting a reviewer chosen by Harmony, comment on the pull request.
 - `defaultRemote` (optional string) -- When pushing new branches, what remote destination should be used.
+- `mainBranch` (optional string) -- When creating a PR, this is the default base branch.
+- `theme` (`dark`/`light`) -- Use colors suited better for either a dark or light Terminal background.
 - `githubPAT` (optional string) -- If the `$GITHUB_PAT` environment variable is not set, this Personal Access Token is used to authenticate with GitHub.
 
 ### Branch
@@ -220,6 +230,8 @@ Running `harmony reflect` will show a summary of your review requests and author
 ![Reflect Screenshot](./docs/images/reflect.png)
 
 ### List
+Running `harmony list` will list all the teams for the configured GitHub organization.
+
 Running `harmony list <team>` will list the members of the given GitHub Team.
 
 ### Graph