From 4915da247bbe1edf3256995027d6892a4789a878 Mon Sep 17 00:00:00 2001
From: cupcakearmy <nicco.borgioli@gmail.com>
Date: Sat, 23 Mar 2019 13:08:35 +0100
Subject: [PATCH] Readme

---
 .gitignore |   4 ++-
 README.md  | 104 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 107 insertions(+), 1 deletion(-)

diff --git a/.gitignore b/.gitignore
index 7c82ca9..a3bbf60 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,5 @@
 node_modules
 package-lock.json
-lib
\ No newline at end of file
+lib
+
+.idea
\ No newline at end of file
diff --git a/README.md b/README.md
index e69de29..bfb7764 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,104 @@
+# Memiens
+
+YAML Settings utility. Nested getter with optional default value and a setter.
+**Typescript typings included**
+
+## Quickstart 🚀
+
+```
+npm i -s memiens
+```
+
+```typescript
+import Memiens from 'memiens'
+
+// Initialize by giving a location for the config file.
+const MySettings = new Memiens('./config.yml')
+
+// This will throw an error if `someconfigvalue` is not found in the yaml
+const A = MySettings.get('someconfigvalue')
+
+// This will not throw an error if `B` is not found
+const B = MySettings.get('B', 'this value is returned and written to the yaml if the config entry does not exist')
+
+// This will look for nested values inside the yaml
+const C = MySettings.get('my.nested.config.value')
+
+// Write something
+MySettings.set('password', 'this is a secret')
+// Nested 
+MySettings.set('config.db.user', 'my_db_user')
+MySettings.set('config.db.port', 1234)
+```
+
+## API 📒
+
+### `.get(setting, default [optional])`
+
+###### Behavior
+Settings can be simple or nested properties.
+If a default value is not provided it will throw an error in case the value is not set. Otherwise the default value will be written into the yaml and returned to the user.
+
+###### Examples
+
+
+```yaml
+# test.yml
+
+db:
+    user: myUser
+    password: $ecr3t
+    port: 1234
+
+simple: a string
+```
+
+```typescript
+import Memiens from 'memiens'
+const Settings = new Memiens('./test.yml')
+
+const simple = Settings.get('simple') // 'a string'
+const db = Settings.get('db') // {user: 'myUser', ...}
+const user = Settings.get('db.user') // 'myUser'
+
+Settings.get('db').user === Settings.get('db.user') // true
+
+Settings.get('notfound') // throws Error
+Settings.get('notfound', 404) // Sets 'notfound' to 404 and returns 404
+```
+
+### `.set(setting, value)`
+
+###### Behavior
+Settings can be simple or nested properties.
+Values can be `string`, `number`, `boolean` or a nested object of those
+
+###### Examples
+
+
+```typescript
+import Memiens from 'memiens'
+const Settings = new Memiens('./result.yml')
+
+const config = {
+	a: true,
+	db: {
+		user: 'myUser',
+		password: '$ecr3t',
+		port: 1234,
+	}
+}
+
+Settings.set('a', config.a)
+Settings.set('db', config.db)
+```
+
+```yaml
+# result.yml
+
+a: true
+db:
+    user: myUser
+    password: $ecr3t
+    port: 1234
+```