From 2ddd022d53d9da936e732d4039985db579b6964e Mon Sep 17 00:00:00 2001
From: Luke Childs <lukechilds123@gmail.com>
Date: Thu, 7 Nov 2019 19:11:08 +0700
Subject: [PATCH] Add usage section to readme

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/README.md b/README.md
index 5fae792..c8b220e 100644
--- a/README.md
+++ b/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