Skip to content

Commit 054117e

Browse files
committed
update readme
1 parent e372cfa commit 054117e

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Example of a batch JSON file (_repositories.json_):
7676

7777
To use the `codeboost` CLI, create a file named `boost.config.js` in your current working directory or run `codeboost init` to create a default configuration file.
7878

79-
This file should export a configuration object with the following properties:
79+
This file should export a `default` configuration object with the following properties:
8080

8181
```typescript
8282
export interface AppSettings {
@@ -89,6 +89,19 @@ export interface AppSettings {
8989
}
9090
```
9191

92+
Example configuration file:
93+
94+
```javascript
95+
module.exports.default = {
96+
github_token: '$CODEBOOST_GITHUB_TOKEN',
97+
repository_storage_path: `${__dirname}/repositories`,
98+
boosts_path: `${__dirname}/boosts`,
99+
use_forks: true,
100+
use_pull_requests: true,
101+
log_target: 'console',
102+
};
103+
```
104+
92105
## Development Setup
93106

94107
```bash

0 commit comments

Comments
 (0)