Updated documentation

aeagle · aeagle · commit 806f1f660feb · 2019-07-23T09:08:54.000+01:00
diff --git a/demo/public/index.html b/demo/public/index.html
@@ -19,7 +19,7 @@
       work correctly both with client-side routing and a non-root public URL.
       Learn how to configure a non-root public URL by running `npm run build`.
     -->
-    <title>React App</title>
+    <title>React Spaces - Divide and conquer your page</title>
   </head>
   <body>
     <noscript>You need to enable JavaScript to run this app.</noscript>
diff --git a/demo/src/App.tsx b/demo/src/App.tsx
@@ -451,6 +451,13 @@ const App: React.FC = () => {
 
           <h2 id="changes">Version history</h2>
 
+          <p>
+                <strong>0.1.3</strong> 
+                <ul>
+                  <li>Added readme</li>
+                  <li>Updated documentation</li>
+                </ul>
+          </p>
           <p>
                 <strong>0.1.2</strong> 
                 <ul>
diff --git a/react-spaces/README.md b/react-spaces/README.md
@@ -0,0 +1,46 @@
+# React Spaces
+
+React Spaces allow you to divide a page or container HTML element into spaces. These spaces know how to behave in relation to each other and can also be divided into further nested spaces.
+
+### Top level spaces
+
+Used at the top level of all other spaces.
+
+**ViewPort**
+
+This space will take over the full viewport of the browser window. Resizing the browser window will automatically adjust the size of this space and all the nested spaces.
+
+**Fixed** 
+
+This space can be given a height and optionally a width (by default it will size to 100% of it's container). All nested spaces will be contained within this fixed size space.
+
+### Inner spaces
+
+These can be used within the top-level spaces **ViewPort** and **Fixed** or nested within other spaces.
+
+**Left** / **Right** 
+
+A space anchored to the left or right of the parent container/space. A size can be specified in pixels to determine its width.
+
+**Top** / **Bottom** 
+
+A space anchored to the top or bottom of the parent container/space. A size can be specified in pixels to determine its height.
+
+**Fill** 
+
+A space which consumes any available area left in the parent container/space taking into account any anchored spaces on every side.
+
+## Getting started
+
+To get started with React Spaces you need:
+
+```typescript
+npm i react-spaces
+```
+
+```typescript
+import * as Spaces from 'react-spaces';
+```
+
+View full documentation here:
+[View examples here](http://www.allaneagle.com/react-spaces/demo/)
