add documentation to readme

Author: g-harel

README.md

@@ -1 +1,57 @@
-# blobs
+# blobs [![](https://img.shields.io/npm/v/blobs.svg)](https://www.npmjs.com/package/blobs)
+
+> random svg blob generator
+
+## Install
+
+```shell
+$ npm install blobs
+```
+
+## Usage
+
+<img align="right" src="blob.svg" />
+
+```typescript
+import blobs form "blobs";
+
+const svg = blobs({
+    size: 300,
+    complexity: 0.4,
+    contrast: 0.4,
+    color: "pink",
+    stroke: {
+        color: "red",
+        width: 2,
+    },
+    guides: true,
+});
+```
+
+## Options
+
+### Required
+
+| Name           | Type       | Description                                   |
+| -------------- | ---------- | --------------------------------------------- |
+| `size`         | `number`   | Bounding box dimensions (in pixels)           |
+| `complexity`   | `number`   | Shape complexity (number of points)           |
+| `contrast`     | `number`   | Shape contrast (randomness of point position) |
+
+
+### Optional
+
+| Name           | Type       | Default    | Description                                   |
+| -------------- | ---------- | ---------- | --------------------------------------------- |
+| `color`        | `string?`  | `none`     | Fill color                                    |
+| `stroke`       | `object?`  | `...`      | Stroke options                                |
+| `stroke.color` | `string`   | `none`     | Stroke color                                  |
+| `stroke.width` | `number`   | `0`        | Stroke width (in pixels)                      |
+| `seed`         | `string?`  | _`random`_ | Value to seed random number generator         |
+| `guides`       | `boolean?` | `false`    | Render points, handles and stroke             |
+
+_Guides will use stroke color and width if defined. Otherwise, they default to `black` stroke with `1` width._
+
+## License
+
+[MIT](./LICENSE)

blob.svg

@@ -33,16 +33,31 @@ export interface SVGPoint {
 }
 
 export interface BlobOptions {
+    // Bounding box dimensions.
     size: number;
-    seed?: string;
+
+    // Shape complexity.
+    complexity: number;
+
+    // Shape contrast.
+    contrast: number;
+
+    // Fill color.
     color?: string;
+
     stroke?: {
+        // Stroke color.
         color: string;
+
+        // Stroke width.
         width: number;
     };
+
+    // Value to seed random number generator.
+    seed?: string;
+
+    // Render points, handles and stroke.
     guides?: boolean;
-    complexity: number;
-    contrast: number;
 }
 
 export interface SmoothingOptions {