From 9e8bf0001082d7836b7a672373e2800f26bbece4 Mon Sep 17 00:00:00 2001
From: Michael Williamson <mike@zwobble.org>
Date: Wed, 25 May 2016 22:41:22 +0100
Subject: Add brief notes on usage

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

(limited to 'README.md')

diff --git a/README.md b/README.md
index 13fc52a..59a9390 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,37 @@
+# Couscous
+
+Convert Java source code to other languages. C# and Python currently supported.
+
+## Usage
+
+1. Build the JAR:
+
+    ```
+    mvn package -Dmaven.test.skip=true
+    ```
+
+2. Create a file called `couscous.json`:
+
+    ```
+    {
+      "backend": "csharp",
+      "sourcepath": [
+        "src/main/java"
+      ],
+      "files": [
+        "src/main/java/com/example",
+      ],
+      "output": "dotnet/Example/generated.cs",
+      "namespace": "Example"
+    }
+    ```
+
+3. In the directory containing `couscous.json`:
+
+    ```
+    java -jar path/to/couscous.jar
+    ```
+
 ## TODO
 
 * Multiple constructors
-- 
cgit v1.2.3