From cedec37cfa6d6a3c99b4c06db38c267063a7f27a Mon Sep 17 00:00:00 2001
From: James Hawkins <jhawki2005@gmail.com>
Date: Sat, 24 Oct 2020 21:57:02 +0100
Subject: [PATCH] readme

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index e69de29..01be34c 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,25 @@
+# whmcs-node
+
+A Typescript/Javascript API wrapper for WHMCS.
+
+## Example use
+
+`npm i whmcs-node`
+
+```js
+// typescript
+import 'WhmcsApi' from 'whmcs-node';
+
+// javascript
+const WhmcsApi = require('whmcs-node')
+
+const whmcs = new WhmcsApi({
+  identifier: "",
+  secret: "",
+  apiUrl: "https://example.com/billing/includes/api.php"
+});
+
+whmcs.tickets.getTicketCounts({})
+  .then((data) => console.log(data))
+  .catch((err) => console.error(err))
+```