From 644bcd79deda8696e191233e1737951264a0510c Mon Sep 17 00:00:00 2001
From: Daniel Rojas <github@danielrojas.net>
Date: Mon, 15 Jun 2020 22:41:11 +0200
Subject: [PATCH] Add usage info to readme

---
 readme.md | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/readme.md b/readme.md
index 6693fab..498cdd8 100644
--- a/readme.md
+++ b/readme.md
@@ -71,15 +71,30 @@ Output file:
 
 [Source](examples/demo02.yml) - [Bill of Materials](examples/demo02.bom.tsv)
 
-
 ### Tutorial and example gallery
 
 See the [tutorial page](tutorial/readme.md) for sample code,
 as well as the [example gallery](examples/readme.md) to see more of what WireViz can do.
 
+## Usage
+
+```
+$ python3 wireviz.py ~/path/to/file/mywire.yml
+```
+
+This will output the following files
+
+```
+mywire.gv         GraphViz output
+mywire.svg        Wiring diagram as vector image
+mywire.png        Wiring diagram as raster image
+mywire.bom.tsv    BOM (bill of materials) as tab-separated text file
+mywire.html       HTML page with wiring diagram and BOM embedded
+```
+
 ## Status
 
-This is very much a [work in progress](todo.md).
+This is very much a [work in progress](todo.md). Source code, API, syntax and functionality may change wildly at any time.
 
 ## Requirements