cleanup and rearrangement
[squeep-lazy-property] / README.md
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..10f677c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Lazy Property
+
+Easily defer property initialization until first access.
+
+`lazy(obj, name, initializer, descriptor, objectBound = true)`
+
+```js
+const { lazy } = require('@squeep/lazy-property');
+
+const obj = {};
+lazy(obj, () => doSomethingExpensive());
+const getItNow = obj.prop;
+```