add example to readme

mdb · May 21, 2016 · d0e2e37 · d0e2e37
1 parent f57eda2
commit d0e2e37
Showing 1 changed file with 28 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -14,9 +14,11 @@ A Golang-based command line application for fetching surf forecast data from the
 
 You'll need:
 
-* Magic Seaweed API Key - this can be [requested from magicseaweed.com](http://magicseaweed.com/developer/sign-up)
+* a Magic Seaweed API Key - this can be [requested from magicseaweed.com](http://magicseaweed.com/developer/sign-up)
 * the ID of the spot you'd like to query - this can be retrieved from a spot's forecast URL. For example, Ocean City, NJ's spot ID is `391`, as per its forecast URL: `http://magicseaweed.com/Ocean-City-NJ-Surf-Report/391/`
 
+View all commands and options:
+
 ```
 $ seaweed-cli
 NAME:
@@ -42,6 +44,31 @@ GLOBAL OPTIONS:
    --version, -v        print the version
 ```
 
+Example usage:
+
+```
+$ seaweed-cli today 392
++--------------------+--------------+--------------+----------------------+------------+
+|        DATE        | SOLID RATING | FADED RATING | PRIMARY SWELL HEIGHT |    WIND    |
++--------------------+--------------+--------------+----------------------+------------+
+| Sat 05/21 02:00 am |            0 |            1 | 2.50ft               | 12 mph E   |
++--------------------+--------------+--------------+----------------------+------------+
+| Sat 05/21 05:00 am |            0 |            1 | 2.50ft               | 10 mph E   |
++--------------------+--------------+--------------+----------------------+------------+
+| Sat 05/21 08:00 am |            0 |            1 | 2.00ft               | 20 mph ENE |
++--------------------+--------------+--------------+----------------------+------------+
+| Sat 05/21 11:00 am |            0 |            1 | 5.00ft               | 22 mph ENE |
++--------------------+--------------+--------------+----------------------+------------+
+| Sat 05/21 02:00 pm |            0 |            2 | 6.50ft               | 22 mph NE  |
++--------------------+--------------+--------------+----------------------+------------+
+| Sat 05/21 05:00 pm |            1 |            1 | 7.00ft               | 19 mph NNE |
++--------------------+--------------+--------------+----------------------+------------+
+| Sat 05/21 08:00 pm |            1 |            1 | 6.50ft               | 15 mph NNE |
++--------------------+--------------+--------------+----------------------+------------+
+| Sat 05/21 11:00 pm |            0 |            2 | 5.50ft               | 17 mph NE  |
++--------------------+--------------+--------------+----------------------+------------+
+```
+
 ## Development
 
 Running lint, tests, etc.: