aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2011-11-16 08:34:56 -0500
committerJason A. Donenfeld <Jason@zx2c4.com>2011-11-16 08:45:18 -0500
commit8a50a5ec03443f4be089ef0e8f1f7726fc988ee1 (patch)
tree43a36243d60d2c5e44ac1b82c8f15b18a946229e
parentInitial commit. (diff)
downloadspark-8a50a5ec03443f4be089ef0e8f1f7726fc988ee1.tar.xz
spark-8a50a5ec03443f4be089ef0e8f1f7726fc988ee1.zip
Add readme.
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e68e57a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Spark
+### Sparklines for Your Shell
+
+Here's a graph of your productivity gains after using `spark`: ▁▂▃▅▇
+
+## Installation
+
+Simply run `make` and then move into /usr/bin or elsewhere in your PATH.
+
+## Usage
+
+Just run `spark` and pass it a space deliminated list of numbers. It's designed to be used in conjunction with other
+scripts that can output in that format.
+
+ $ spark 0 30 55 80 33 150
+ ▁▂▄▅▃█
+
+Invoke help with `spark -h`.
+
+## Example
+
+Magnitude of earthquakes over 1.0 in the last 24 hours:
+
+ $ curl -s http://earthquake.usgs.gov/earthquakes/catalogs/eqs1day-M1.txt | cut -d, -f9 | xargs spark
+ ▁▂▂▂▁▂▁▁▁▂▁▄▁▂▂▂▃▁▂▂▂▃▃▂▂▂▂▁▁▁▁▁▂▁▂▆▃▂▂▂▂▁▅▂▂▂▆▂▁▂▂▂▂▁▁▂▃▂▃▁▁▁▁▅▂▃▂▄▁▃▁▂▁▂▁▅▁▁▂▅▁▂▁▂▁▁▁▂▁▁▁▁▁▁▃▁▂▁
+