Skip to content

Commit

Permalink
Clarify usage
Browse files Browse the repository at this point in the history
  • Loading branch information
Nezrahm committed Feb 20, 2022
1 parent ec725b9 commit 7ca7a5b
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ NB: You must play the game via the Electron client (the Steam version) to be abl

## Install

Install in your project via `npm install bitburner-sync`. It can be installed as a global tool but it then looses the ability to be configured in package.json.
Install in your project via `npm install bitburner-sync`.

It can also be installed as a global tool via `npm install bitburner-sync -g`.

## Usage

Can be used from the terminal. Use `bitburner-sync -help` for full information.
Can be used from the terminal, then always prefix the calls with `npx`. Use `npx bitburner-sync -help` for full information.

| Option | Description |
|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand Down

0 comments on commit 7ca7a5b

Please sign in to comment.