Skip to content

Commit 79afaa8

Browse files
committed
update docs
1 parent ee36755 commit 79afaa8

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,18 +78,20 @@ Boosts are stored by default in `~/.codeboost/boosts`, and examples can be found
7878

7979
## Configuration
8080

81-
To use the `codeboost` CLI, create a file named `codeboost.config.js` in your current working directory or run `codeboost init` to create a default configuration file.
81+
To use the [`codeboost` CLI](./docs/cli.md), create a file named `codeboost.config.js` in your current working directory or run `codeboost init` to create a default global configuration file.
8282

8383
The default configuration file is stored in `~/.codeboost/codeboost.config.js`. This file assumes that you have an environment variable named `CODEBOOST_GITHUB_TOKEN` that contains a valid GitHub personal access token with the `repo` scope. You may edit this file to use a different token or to change the default storage paths.
8484

85-
This file should export a `default` configuration object with the following properties:
85+
The configuration file should export a `default` configuration object with the following properties:
8686

8787
```typescript
8888
export interface AppSettings {
8989
github_token: string;
9090
repository_storage_path: string;
9191
boosts_path: string;
92+
// create fork of each repository
9293
use_forks: boolean;
94+
// create pull request for each repository
9395
use_pull_requests: boolean;
9496
log_target: 'console' | 'file';
9597
}
@@ -111,6 +113,10 @@ module.exports.default = {
111113
> Note that the `github_token` property can be set to a string value or an environment variable name prefixed with a '$'.
112114
> If the value is an environment variable name, the value of the environment variable will be used.
113115
116+
If you are working on repositories that you have push access to and don't want to create forks or pull requests, you can set the `use_forks` and `use_pull_requests` properties to `false`. This will cause `codeboost` to commit directly to the main branch of the repository.
117+
118+
If you disable `use_forks` but not `use_pull_requests`, a separate branch will be created on the repository and a pull request will be created for that branch. Enabling `use_forks` automatically enables `use_pull_requests`.
119+
114120
## Development Setup
115121

116122
```bash

0 commit comments

Comments
 (0)