From f41b5f51402d30b7ee6db2819fe0cf2d18385be6 Mon Sep 17 00:00:00 2001
From: Joey <jyapayne@gmail.com>
Date: Mon, 2 Feb 2015 14:24:30 +1300
Subject: [PATCH] Update README.md

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 49074f9..6eb5d5c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,28 @@
-# nim-extentions
+# nim-extensions
 Extensions for the nim programming language.
+
+These extensions aim to improve the usability of nim in practical applications.
+
+Extensions so far include:
+
+## OOP macro
+  usage: 
+  
+  ```nim
+  class BaseObject: # inherits from RootObj
+    # attributes/properties
+    var
+      x: int
+      y: float
+      
+    method override_me(argx: float): int=
+      result = int(argx) + self.x
+      
+  class ClassName of BaseObject:
+      method method_name(arg1: int, arg2: float=0.3): float=
+        ## do stuff here
+        result = arg2
+        
+      method override_me(argx: float): int=
+        result = int(self.y) + int(argx) + self.x
+  ```