From ac711cfeb0501da332e2355ed341aca776b722d4 Mon Sep 17 00:00:00 2001
From: Justin Worthe <justin.worthe@gmail.com>
Date: Sun, 12 Feb 2017 05:54:21 +0200
Subject: Renamed main file to better fit browser use

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

(limited to 'README.md')

diff --git a/README.md b/README.md
index de3e46f..b8c80f3 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,31 @@ and [here](http://knowles.co.za/generating-south-african-id-numbers/).
 Usage
 -----
 
+Download the library from NPM using the following command in a terminal:
+
+```
+npm install --save south-african-id-parser
+```
+
+### Usage In NodeJS
+
+```
+var saIdParser = require('south-african-id-parser');
+var info = saIdParser.parse('9001049818080');
+```
+
+### Usage In the Browser
+
+When used in the browser, the library will add the `saIdParser` object
+to the window for you to use.
+
+```
+<script src="south-african-id-parser.js"></script>
+<script>
+    var info = saIdParser.parse('9001049818080');
+</script>
+```
+
 ### Parse Everything
 
 The package exposes the `.parse(idNumber)` method for calling all of
-- 
cgit v1.2.3