Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
aadityabhatia committed Aug 12, 2023
1 parent 8ddb93c commit 8cf5ce0
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Expand Up @@ -4,17 +4,32 @@ A modular generals.io bot framework for development and analysis of game strateg

## Installation

Install and run the executable:

```sh
npm install -g @corsaircoalition/commander-cortex
commander-cortex --help
```
npm install
npm run build

or run directly from npm library:

```sh
npx @corsaircoalition/commander-cortex --help
```

## Configuration

Copy `config.json.example` to `config.json` and make updates as needed.
Copy [`config.json.example`](https://github.com/CorsairCoalition/docs/blob/main/config.json.example) to `config.json` and make desired changes.

## Usage

```
node . config.json
Usage: @corsaircoalition/commander-cortex [options] <configFile>
a modular generals.io bot framework for development and analysis of game strategies and actions
Options:
-V, --version output the version number
-d, --debug enable debugging (default: false)
-h, --help display help for command
```

0 comments on commit 8cf5ce0

Please sign in to comment.