feat: all --octoherd-* flags are now optional (#4)

BREAKING CHANGE: Repositories can no longer be passed as positional argument, use the `--octoherd-repos` (or `-R`) CLI flag instead.

  Before:

  ```
  npx @octoherd/script-add-octoherd-cli-to-script "@octokit/*"
  ```

  After

  ```
  npx @octoherd/script-add-octoherd-cli-to-script --octoherd-repos "@octokit/*"
  ```

  Or do not set `--octoherd-repos` at all, in which case the user will be prompted.

Co-authored-by: Gregor Martynus <[email protected]>

Author: octoherd[bot]

README.md

@@ -6,13 +6,31 @@ This script is specific to the needs of a one-time migration for [@octoherd](htt
 
 ## Usage
 
+Minimal usage
+
+```
+$ npx @octoherd/script-create-repositories-from-script-folders \
+  --path-to-folders "scripts"
+```
+
+Pass all options as CLI flags to avoid user prompts
+
 ```
 $ npx @octoherd/script-create-repositories-from-script-folders \
-  --octoherd-token 0123456789012345678901234567890123456789 \
-  "octoherd/script-create-repositories-from-script-folders" \
-  --path-to-folders "scripts/**"
+  --path-to-folders "scripts" \
+  -T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \
+  -R "octoherd/repository-with-script-folders"
 ```
 
+## Options
+
+| option                       | type             | description                                                                                                                                                                                                                                 |
+| ---------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `--path-to-folders`          | string           | **Required.** Relative path to where the folders are located                                                                                                                                                                                |
+| `--octoherd-token`, `-T`     | string           | A personal access token ([create](https://github.com/settings/tokens/new?scopes=repo)). Script will create one if option is not set                                                                                                         |
+| `--octoherd-repos`, `-R`     | array of strings | One or multiple space-separated repositories in the form of `repo-owner/repo-name`. `repo-owner/*` will find all repositories for one owner. `*` will find all repositories the user has access to. Will prompt for repositories if not set |
+| `--octoherd-bypass-confirms` | boolean          | Bypass prompts to confirm mutating requests                                                                                                                                                                                                 |
+
 ## License
 
 [ISC](LICENSE.md)