Updated: readme file

Author: Daniel Botha

README.md

@@ -18,38 +18,121 @@ Create generative art by using the canvas api and node js. Before you use the ge
 
 ## Installation
 
+If you are cloning the project the run this first, otherwise you can download the source code on the release page and skip this step.
+
 ```sh
 git clone https://github.com/HashLips/hashlips_art_engine.git
+```
+
+Go to the root of you folder and run this command if you have yarn installed.
 
+```sh
 yarn add all
 ```
 
+Alternativly you can run this command if you have node installed.
+
+```sh
+npm install
+```
+
 ## Usage
 
-Create your different layers as folders in the 'layers' directory, and add all the layer assets in these directories. You can name the assets anything as long as it has a rarity weight attached in the file name like so: `example element*70.png`
+Create your different layers as folders in the 'layers' directory, and add all the layer assets in these directories. You can name the assets anything as long as it has a rarity weight attached in the file name like so: `example element#70.png`. You can optionally change the delimiter `#` to anything you would like to use in the variable `rarityDelimiter` in the `src/config.js` file.
 
-Once you have all your layers, go into `src/config.js` and update the `layersOrder` array to be your layer folders name in order of the back layer to the front layer.
+Once you have all your layers, go into `src/config.js` and update the `layerConfigurations` objects `layersOrder` array to be your layer folders name in order of the back layer to the front layer.
 
-*Example:* If you were creating a portrait design, you might have a background, then a head, a mouth, eyes, eyewear, and then headwear, so your `layersOrder` would look something like this:
+_Example:_ If you were creating a portrait design, you might have a background, then a head, a mouth, eyes, eyewear, and then headwear, so your `layersOrder` would look something like this:
 
 ```js
-const layersOrder = [
-    { name: 'Background'},
-    { name: 'Ball'},
-    { name: 'Eye color' },
-    { name: 'Iris' },
-    { name: 'Shine' },
-    { name: 'Bottom lid' },
-    { name: 'Top lid' },
+const layerConfigurations = [
+  {
+    growEditionSizeTo: 100,
+    layersOrder: [
+      { name: "Head" },
+      { name: "Mouth" },
+      { name: "Eyes" },
+      { name: "Eyeswear" },
+      { name: "Headwear" },
+    ],
+  },
 ];
 ```
 
-The `name` of each layer object represents the name of the folder (in `/layers/`) that the images reside in. 
+The `name` of each layer object represents the name of the folder (in `/layers/`) that the images reside in.
+
+Optionally you can now add multiple different `layerConfigurations` to you collection. Each confugiration can be uinque and have different layer order, use the same layers or intruduce new onces. This gives the artist flexibility when it comes to fine tuning their collections to their needs.
+
+_Example:_ If you were creating a portrait design, you might have a background, then a head, a mouth, eyes, eyewear, and then headwear and you want to create a new race or just simple re-order the layers or even introduce new layers, so your `layerConfigurations` and `layersOrder` would look something like this:
+
+`````js
+const layerConfigurations = [
+  {
+    // Creates upto 50 artworks
+    growEditionSizeTo: 50,
+    layersOrder: [
+      { name: "Background" },
+      { name: "Head" },
+      { name: "Mouth" },
+      { name: "Eyes" },
+      { name: "Eyeswear" },
+      { name: "Headwear" },
+    ],
+  },
+  {
+    // Creates an aditional 100 artworks
+    growEditionSizeTo: 150,
+    layersOrder: [
+      { name: "Background" },
+      { name: "Head" },
+      { name: "Eyes" },
+      { name: "Mouth" },
+      { name: "Eyeswear" },
+      { name: "Headwear" },
+      { name: "AlienHeadwear" },
+    ],
+  },
+];
+```
 
-Then optionally, update your `format` size, ie the outputted image size, and the `editionSize`, which is the amount of variation outputted.
+Then optionally, update your `format` size, ie the outputted image size, and the `growEditionSizeTo` on each `layerConfigurations` object, which is the amount of variation outputted.
 
 When you are all ready, run the following command and your outputted art will be in the `build` directory:
 
 ```sh
 npm run build
 ```
+
+or
+
+```sh
+node index.js
+```
+
+The program will output all the images in the `build` directory along with the metadata files. Each collection will have a `_metadata.json` file that consists of all the metadata in the collection inside the `build` folder. The `build` folder also will contain alll the images as well as single json files that represents each image file. The single json file of a image will look somthing like this:
+
+````json
+{
+  "dna": "d956cdf4e460508b5ff90c21974124f68d6edc34",
+  "name": "#1",
+  "description": "This is the description of your NFT project, remember to replace this",
+  "image": "https://hashlips/nft/1.png",
+  "edition": 1,
+  "date": 1631690799975,
+  "attributes": [
+    { "trait_type": "Background", "value": "Black" },
+    { "trait_type": "Eyeball", "value": "Red" },
+    { "trait_type": "Eye color", "value": "Yellow" },
+    { "trait_type": "Iris", "value": "Small" },
+    { "trait_type": "Shine", "value": "Shapes" },
+    { "trait_type": "Bottom lid", "value": "Low" },
+    { "trait_type": "Top lid", "value": "Middle" }
+  ],
+  "compiler": "HashLips Art Engine"
+}
+```
+
+Thats it, your done. Hope you create some awesome artworks with this code.
+
+
+`````