Add readme

Author: donchev7

README.md

@@ -1,2 +1,36 @@
 # typescript-sdk
-Typescript SDK for GetTestMail
+Typescript client for interacting with the GetTestMail API, which provides a simple way to create temporary email addresses and receive emails sent to them.
+
+## Installation
+```bash
+npm install @gettestmail/typescript-sdk
+```
+
+## Compatibility
+
+>Works on Browser, Node.js and React Native!
+
+
+## Usage
+
+To create a new GetTestMail API client, you need to instantiate the GetTestMail class with your API key. To get an API key, sign up for a free [account](https://gettestmail.com).
+
+
+```typescript
+import { GetTestMail } from "@gettestmail/typescript-sdk";
+
+const testMail = new GetTestMail('YOUR_API_KEY')
+```
+
+### Create a new email address
+
+```typescript
+const mailBox = await testMail.createNew()
+```
+
+### Wait for an email to be received
+
+```typescript
+const { message } = await testMail.waitForMessage(mailBox.emailAddress)
+```
+

lib/client.ts

@@ -1,4 +1,4 @@
-import { APIError, CreateNewRequest, CreateNewResponse, GetTestMail, Problem, WaitForMessageResponse } from "./models";
+import { APIError, CreateNewRequest, GetTestMail, Problem } from "./models";
 
 class GetTestMailClient {
   private apiKey: string;
@@ -9,7 +9,7 @@ class GetTestMailClient {
     this.baseUrl = baseUrl;
   }
 
-  async createNew(request?: CreateNewRequest): Promise<CreateNewResponse> {
+  async createNew(request?: CreateNewRequest): Promise<GetTestMail> {
     const response = await fetch(`${this.baseUrl}/gettestmail`, {
       method: 'POST',
       headers: {
@@ -23,12 +23,12 @@ class GetTestMailClient {
       const problem: Problem = await response.json();
       throw new APIError(problem);
     }
-
     const getTestMail: GetTestMail = await response.json();
-    return { getTestMail };
+
+    return getTestMail;
   }
 
-  async waitForMessage(id: string): Promise<WaitForMessageResponse> {
+  async waitForMessage(id: string): Promise<GetTestMail> {
     const response = await fetch(`${this.baseUrl}/gettestmail/${id}`, {
       method: 'GET',
       redirect: 'follow',
@@ -42,9 +42,9 @@ class GetTestMailClient {
       const problem: Problem = await response.json();
       throw new APIError(problem);
     }
-
     const getTestMail: GetTestMail = await response.json();
-    return { getTestMail };
+
+    return getTestMail;
   }
 }
 

lib/models.ts

@@ -44,11 +44,3 @@ export class APIError extends Error {
 export type CreateNewRequest = {
   expiresAt: string;
 };
-
-export interface CreateNewResponse {
-  getTestMail: GetTestMail;
-}
-
-export interface WaitForMessageResponse {
-  getTestMail: GetTestMail;
-}