Skip to content
This repository has been archived by the owner on Sep 22, 2021. It is now read-only.

Commit

Permalink
Update the document.
Browse files Browse the repository at this point in the history
  • Loading branch information
jkawamoto committed Nov 24, 2017
1 parent 89aa00d commit 73bf799
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ primary-seed = foo bar baz foo bar baz foo bar baz foo bar baz foo bar baz foo b
## Usage
1. Open a Command Prompt / Terminal
2. Navigate to the extracted goobox-sync-sia folder
3. Run the batch file, i.e. goobox-sync-sia.bat (for Windows), goobox-sync-sia (for Mac/Linux)
3. Run the batch file, i.e. `goobox-sync-sia.bat` (for Windows), `goobox-sync-sia` (for Mac/Linux)


Currently this app supports basic one-way sync from the SIA cloud to the local file system.
Expand All @@ -56,5 +56,19 @@ The app uses an embedded Nitrine database for storing the current sync state of
The `list-db.bat` (for Windows) `list-db` (for Max/Linux) scripts can be used to dump the content of the database.
This might be useful for debugging.

### Sub commands
`goobox-sync-sia.bat` and `goobox-sync-sia` have some sub commands.

#### wallet command
`goobox-sync-sia.bat wallet` and `goobox-sync-sia wallet` print the following your wallet information:

- the main wallet address
- confirmed balance (in SC)
- current spending
- current prices (approx.)

#### create-allowance command
`goobox-sync-sia.bat create-allowance` and `goobox-sync-sia create-allowance` creates allowance. By default, this command adds your confirmed balance to the fund. You can choose hastings to be added to the fund with `--fund` flag, e.g. `goobox-sync-sia.bat create-allowance --fund 100000` add 100000 hastings to your current fund.

## License
This software is released under The GNU General Public License Version 3, see [LICENSE](LICENSE) for more detail.

0 comments on commit 73bf799

Please sign in to comment.