chore: update readme

README.md

@@ -1,7 +1,56 @@
 # configurator
+easy optional configuration that overlays optional propers over a base or default config
+
+## behavior
+```js
+import createConfigurator from '@john-ko/configurator'
+const config = {
+  nestedOption: {
+    somekeys: 'apple',
+    nestedOptionAgain: {
+      somekeys: 'banana',
+      nestedOption: {
+        somekeyA: 'a',
+        somekeyB: 'b'
+      }
+    }
+  }
+}
+const { defineConfig } = createConfigurations(config)
+
+// you can export it out
+// export { defineConfig }
+
+// or
+const cfg = defineConfig({
+  nestedOption: {
+    nestedOptionAgain: {
+      nestedOption: {
+        somekeyA: 'AAAAA'
+      }
+    }
+  }
+})
+
+//outputs
+console.log(JSON.string(cfg))
+// {
+//   "nestedOption": {
+//     "somekeys": "apple",
+//     "nestedOptionAgain": {
+//       "somekeys": "banana",
+//       "nestedOption": {
+//         "somekeyA": "AAAAA",
+//         "somekeyB": "b"
+//       }
+//     }
+//   }
+// }
+```
 
 ## usage
 
+### example
 ```ts
 // config.ts
 import createConfigurator from '@john-ko/configurator'
@@ -45,4 +94,4 @@ import { defineConfig } = './config.js'
 
 /** all options are optional, and will overlay on default config */
 export default defineConfig({})
-```
+```

package.json

@@ -24,6 +24,11 @@
     "./dist/index.d.ts"
   ],
   "author": "John Ko",
+  "homepage": "https://github.com/john-ko/configurator/#readme",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:john-ko/configurator.git"
+  },
   "license": "ISC",
   "devDependencies": {
     "@types/jest": "^29.5.4",