Clean up (#24)

* cleaned up readme

* added another test for props

* adds a simple example

README.md

@@ -1,4 +1,4 @@
-# configamajig
+# <img src="configamajig_icon.png" width="50px"/> configamajig 
 
 You know when you have 20 apps and they all are basically configured the same way, but not 100% the same? This is for that problem.
 
@@ -13,9 +13,34 @@ You need to sometimes use one value vs another in an env depending on another de
 
 Confused why something doesn't seem to template like you expect? configamajig has full value tracing so you can see which file changed what value super easy!
 
+## Install
+
+`brew install mtintes/configamajig/configamajig`
+
+Or `brew tap mtintes/configamajig` and then `brew install configamajig`.
+
+Or find latest build under [releases](https://github.com/mtintes/configamajig/releases)
+
+## Tips
+"configamajig" is a lot for anyone to type out. We recommend setting up an alias!
+
 ## Commands
 
+### Generate Config
+To generate a basic config file:
+```configamajig generate config >> config.json```
+
 ### Replace:
 Feed in an template file + a config and out comes a fully filled out file
 
 ```configamajig replace -c <CONFIG.json> -i <INPUT> -o <OUTPUT>```
+
+### Read Key:
+For finding the value of a specific key
+
+```configamajig read key -c <CONFIG.json> -o <OUTPUT>", "some.key"```
+
+
+## Contributing
+
+Wow, um that is super cool if you do want to help. I guess to start read through the current issue and if you think you can solve something or want to take a shot then post something on said issue. I guess we will figure it out from there.

cli/actions/memoryMap_test.go

@@ -666,3 +666,35 @@ func TestMemoryMapWithIntPropsIsOutlawed(t *testing.T) {
 	assert.Nil(t, err)
 	assert.Equal(t, fmt.Sprint(expectedMemoryMap), fmt.Sprint(memoryMap))
 }
+
+func TestMemoryMapWithMappedProps(t *testing.T) {
+
+	Config := ConfigurationMap{
+		Configs: []Config{
+			{
+				Props: map[string]interface{}{
+					"key": map[string]interface{}{
+						"key1": "value",
+					},
+				},
+				Mappings: []Mapping{
+					{
+						InPath: "key",
+						ToPath: "newKey",
+					},
+				},
+			},
+		},
+	}
+
+	expectedMemoryMap := map[string]interface{}{
+		"newKey": map[string]interface{}{
+			"key1": "value",
+		},
+	}
+
+	memoryMap, _, err := ReadMemoryMap(&Config)
+
+	assert.Nil(t, err)
+	assert.Equal(t, fmt.Sprint(expectedMemoryMap), fmt.Sprint(memoryMap))
+}

example-files/replaceCmdExamples/simple/README.md

@@ -0,0 +1,7 @@
+To Run:
+
+```configamajig replace -c config.json -i input1.txt -o output.txt```
+
+or with trace
+
+```configamajig replace -c config.json -i input1.txt -o output.txt -t trace.md```

example-files/replaceCmdExamples/simple/config.json

@@ -0,0 +1,33 @@
+{
+    "configs": [
+        {
+            "path": "global.json",
+            "mappings": [
+                {
+                    "inPath": "globalAppConfigs",
+                    "toPath": "globals"
+                },
+                {
+                    "inPath": "deploymentConfigs",
+                    "toPath": "deploymentValues"
+                }
+            ],
+            "applyFile": "after"
+        },
+        {
+            "path": "regional.json",
+            "mappings": [
+                {
+                    "inPath": "globalAppConfigs",
+                    "toPath": "globals"
+                },
+                {
+                    "inPath": "deploymentConfigs",
+                    "toPath": "deploymentValues"
+                }
+            ],
+            "applyFile": "later"
+        }
+    ],
+    "version": "1.0.0"
+}

example-files/replaceCmdExamples/simple/global.json

@@ -0,0 +1,11 @@
+{
+    "globalAppConfigs":{
+        "dbConfigs": "someGlobalConnectionString",
+        "someAPIKey": "someAPIKey",
+        "someOtherGlobalConfigs": "someOtherGlobalConfigs"
+    },
+    "deploymentConfigs":{
+        "stage": "development",
+        "someOtherConfigs": "someOtherConfigs"
+    }
+}

example-files/replaceCmdExamples/simple/input1.txt

@@ -0,0 +1,3 @@
+global.dbConfigs: {{ .globals.dbConfigs }}
+
+deploymentValues.stage: {{ .deploymentValues.stage }}

example-files/replaceCmdExamples/simple/regional.json

@@ -0,0 +1,10 @@
+{
+    "globalAppConfigs":{
+        "dbConfigs": "someRegionalConnectionString",
+        "someAPIKey": "someAPIKey"
+    },
+    "deploymentConfigs":{
+        "stage": "integration",
+        "someOtherConfigs": "someOtherConfigs"
+    }
+}