Skip to content

Commit 22d0e66

Browse files
committed
Move enhancement ideas to Issues out of the README
1 parent 529ba6d commit 22d0e66

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ npm install -g github-default-branch
1919

2020
## Authentication
2121

22-
[Create a personal access token](https://github.com/settings/tokens/new) with the `repo` scope. This is the value for `<token>` in the examples
22+
[Create a personal access token](https://github.com/settings/tokens/new) with the `repo` scope. This is the value for `<token>` in the examples.
23+
24+
> If you don't want your token to be stored in your shell history, you can set `GITHUB_TOKEN` in the environment and that will be read instead
2325
2426
## Usage
2527

@@ -29,6 +31,12 @@ github-default-branch --pat <token> --repo user/repo
2931
3032
# Rename dev to develop
3133
github-default-branch --pat <token> --repo user/repo --old dev --new develop
34+
35+
# Rename all repos owned by an org
36+
github-default-branch --pat <token> --org my-org-name
37+
38+
# Rename all repos owned by a user
39+
github-default-branch --pat <token> --user my-user
3240
```
3341

3442
Run with the `--verbose` flag to see debug information
@@ -41,12 +49,6 @@ Run with the `--verbose` flag to see debug information
4149
| --repo <name> | The repo to update (format: user/repo) | N/A |
4250
| --user <name> | Update all repos owned by the provided user (example: my-user) | N/A |
4351
| --org <name> | Update all repos in the provided org (example: my-org-name) | N/A |
44-
| --keep-old | | false |
52+
| --keep-old | Keep the old branch rather than deleting it | false |
4553
| --old | The name of the branch to rename | master |
4654
| --new | The new branch name | main |
47-
48-
## Enhancements
49-
50-
- Error if the target branch already exists
51-
- `--visibility` flag (`all`, `public`, `private`). Default `all`
52-
- Copy branch protections from the old branch to the new one

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)