entrijs 0.0.0-beta.5 → 0.0.1

package/README.md

@@ -0,0 +1,70 @@
+# EntriJS
+
+Use [Entri](https://www.entri.com) with your JavaScript application.
+
+For full developer documentation, see: https://developers.entri.com
+
+## Get started
+
+### Install the package
+
+```
+npm install entrijs
+```
+or
+```
+yard add entrijs
+```
+
+### Open the Entri modal
+
+```
+import {showEntri} from 'entrijs';
+
+const config = {
+  applicationId: '123sample',
+  dnsRecords: [
+    {
+      type: "CNAME",
+      host: "www",
+      value: "m.test.com",
+      ttl: 300,
+    },
+  ],
+  token: '345sample',
+};
+
+showEntri(config);
+```
+
+[Read more about the `config` object](https://developers.entri.com/api-reference#entri-showentri-config).
+
+To close the modal:
+
+```
+import {close} from 'entrijs';
+
+close();
+```
+
+### Check domain
+
+See the [full documentation](https://developers.entri.com/api-reference#check-domain).
+
+```
+import {checkDomain} from 'entrijs';
+
+const init = async () => {
+  const result = await checkDomain('mydomain.com', config);
+};
+```
+
+### Purchase domain
+
+See the [full documentation](https://developers.entri.com/api-reference#entri-purchasedomain-config).
+
+```
+import {purchaseDomain} from 'entrijs';
+
+purchaseDomain(config);
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "entrijs",
-  "version": "0.0.0-beta.5",
+  "version": "0.0.1",
   "description": "Entri",
   "source": "src/index.ts",
   "main": "dist/main.js",