fix(readme): add links to documentation

package.json

@@ -15,12 +15,14 @@
   "devDependencies": {
     "@gitzone/tsbuild": "^2.0.22",
     "@gitzone/tstest": "^1.0.15",
+    "@pushrocks/qenv": "^4.0.6",
     "@pushrocks/tapbundle": "^3.0.7",
     "@types/node": "^10.11.7",
     "tslint": "^5.11.0",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
+    "@pushrocks/smartletter": "^1.0.10",
     "@pushrocks/smartrequest": "^1.1.42"
   },
   "files": [

qenv.yml

@@ -0,0 +1,3 @@
+required:
+  - API_EMAIL
+  - API_TOKEN

readme.md

@@ -18,6 +18,9 @@ an unofficial API package for the letterxpress API
 
 ## Usage
 
+Use TypeScript for best in class intellisense.
+
+letterxpress implements the LXP API documented here: [LXP API Documentation](https://www.letterxpress.de/briefe-uebertragen/api)
 
 ## Contribution
 

test/test.ts

@@ -1,10 +1,16 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 import * as letterxpress from '../ts/index';
 
+import { Qenv } from '@pushrocks/qenv';
+let testQenv = new Qenv('./', './.nogit/');
+
 let testAccount: letterxpress.LetterXpressAccount;
 
 tap.test('should create a valid account', async () => {
-  testAccount = new letterxpress.LetterXpressAccount();
+  testAccount = new letterxpress.LetterXpressAccount({
+    apiKey: testQenv.getEnvVarOnDemand('API_TOKEN'),
+    email: testQenv.getEnvVarOnDemand('API_EMAIL')
+  });
   expect(testAccount).to.be.instanceOf(letterxpress.LetterXpressAccount);
 });
 

ts/letterxpress.classes.account.ts

@@ -1,5 +1,16 @@
 import * as plugins from './letterxpress.plugins';
 
-export class LetterXpressAccount {
-  
+export interface ILetterXpressConstructorOptions {
+  email: string;
+  apiKey: string;
+}
+
+export class LetterXpressAccount {
+  public options: ILetterXpressConstructorOptions;
+
+  constructor(optionsArg: ILetterXpressConstructorOptions) {
+    this.options = optionsArg;
+  }
+
+  public request() {}
 }

ts/letterxpress.plugins.ts

@@ -1,5 +1,3 @@
 import * as smartrequest from '@pushrocks/smartrequest';
 
-export {
-  smartrequest
-};
+export { smartrequest };