docs: Show imports

bennycode · Dec 5, 2020 · e76afb0 · e76afb0
1 parent 5783f92
commit e76afb0
Show file tree

Hide file tree

Showing 5 changed files with 71 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,46 @@
 
 Unofficial [IG Trading API](https://labs.ig.com/rest-trading-api-guide) for Node.js, written in TypeScript.
 
+## Installation
+
+**npm**
+
+```bash
+npm install ig-trading-api
+```
+
+**Yarn**
+
+```bash
+yarn add ig-trading-api
+```
+
+## Setup
+
+**JavaScript / Node.js**
+
+```javascript
+const {APIClient} = require('ig-trading-api');
+const client = new APIClient('your-api-key');
+```
+
+**TypeScript**
+
+```typescript
+import {APIClient} from 'ig-trading-api';
+const client = new APIClient('your-api-key');
+```
+
+## Usage
+
+### Login
+
+```typescript
+const session = await client.rest.login.createSession('your-username', 'your-password');
+console.info(`Your client ID is "${session.clientId}".`);
+```
+
 ## Useful links
 
-- [IG REST Trading API Reference](https://labs.ig.com/rest-trading-api-reference)
 - [IG API Companion](https://labs.ig.com/sample-apps/api-companion/index.html)
+- [IG REST Trading API Reference](https://labs.ig.com/rest-trading-api-reference)
diff --git a/docs/index.html b/docs/index.html
@@ -1,27 +1,27 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <title>IG Trading API for Node.js, written in TypeScript.</title>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
-    <meta name="description" content="IG Trading API for Node.js, written in TypeScript." />
-    <meta
-      name="viewport"
-      content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
-    />
-    <link rel="stylesheet" href="//unpkg.com/docsify@4.11.6/lib/themes/vue.css" />
-  </head>
-  <body>
-    <div id="app"></div>
-    <script>
-      window.$docsify = {
-        basePath: "https://bennycode.com/ig-trading-api",
-        loadSidebar: true,
-        name: "IG Trading API",
-        relativePath: true,
-        repo: "https://github.com/bennycode/ig-trading-api"
-      };
-    </script>
-    <script src="//unpkg.com/docsify@4.11.6/lib/docsify.min.js"></script>
-  </body>
-</html>
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>IG Trading API for Node.js, written in TypeScript.</title>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+    <meta name="description" content="IG Trading API for Node.js, written in TypeScript." />
+    <meta
+      name="viewport"
+      content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
+    />
+    <link rel="stylesheet" href="//unpkg.com/docsify@4.11.6/lib/themes/vue.css" />
+  </head>
+  <body>
+    <div id="app"></div>
+    <script>
+      window.$docsify = {
+        basePath: 'https://bennycode.com/ig-trading-api',
+        loadSidebar: true,
+        name: 'IG Trading API',
+        relativePath: true,
+        repo: 'https://github.com/bennycode/ig-trading-api',
+      };
+    </script>
+    <script src="//unpkg.com/docsify@4.11.6/lib/docsify.min.js"></script>
+  </body>
+</html>
diff --git a/package.json b/package.json
@@ -40,6 +40,7 @@
     "!/dist/demo",
     "!/dist/test"
   ],
+  "homepage": "https://bennycode.com/ig-trading-api",
   "keywords": [
     "API",
     "CFD",

diff --git a/src/demo/login.ts b/src/demo/login.ts
@@ -5,8 +5,8 @@ import {APIClient} from '../APIClient';
 async function main(): Promise<void> {
   const {IG_API_KEY: apiKey, IG_USERNAME: username, IG_PASSWORD: password} = process.env;
   const client = new APIClient(`${apiKey}`);
-  const account = await client.rest.login.createSession(`${username}`, `${password}`);
-  console.info(`Your client ID is "${account.clientId}".`);
+  const session = await client.rest.login.createSession(`${username}`, `${password}`);
+  console.info(`Your client ID is "${session.clientId}".`);
 }
 
 main().catch(console.error);
diff --git a/src/index.ts b/src/index.ts
@@ -1,4 +1,5 @@
 import {APIClient} from './APIClient';
 export default APIClient;
 
+export * from './APIClient';
 export * from './login';