Browse Source

Add usage section to readme

pull/1/head
Luke Childs 5 years ago
parent
commit
2ddd022d53
  1. 32
      README.md

32
README.md

@ -10,6 +10,38 @@ Inspired by this feature request:
- https://twitter.com/lukechilds/status/1192252814262599680
- https://ideas.digitalocean.com/ideas/BSX-I-6
## Usage
```
$ checkvolumesize --help
checkvolumesize 1.0.0
Automatically expand Digital Ocean block storage volumes.
Usage: checkvolumesize [options]
Options:
--help | -h | help [Optional] Show this help message
--token [Required] Digital Ocean API token
--device [Required] The volume's block device
--volume-name [Required] The volume's name
--volume-region [Required] The volume's region
--buffer [Optional] The amount of GB to keep available Default: 10
--log [Optional] Prepend timestamps to stdout
Example:
checkvolumesize /
--token bc99be9f73b037da64074472fe58f643e619328b85c5467615964a59abd12029 /
--device /dev/sda /
--volume-name volume-sgp1-01 /
--volume-region sgp1 /
--buffer 10
GitHub: https://github.com/lukechilds/autoscale-do-block-storage
```
## License
MIT © Luke Childs

Loading…
Cancel
Save