Merge pull request #2 from hendrixroa/update-readme

Update readme

.npmignore

@@ -1 +1,2 @@
-lib/
+lib/
+.idea/

README.md

@@ -1,5 +1,58 @@
 ![alt text](./images/cognito-defender.png)
 
-# cognito-defender
-Cloud based painless wrapper library to handle authentication via AWS Cognito using JWT capabilities
+[![NPM](https://nodei.co/npm/cognito-defender.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/cognito-defender/)
 
+> Inspired in this post [Amazon Cognito User Pools in NodeJS as fast as possible](https://medium.com/@prasadjay/amazon-cognito-user-pools-in-nodejs-as-fast-as-possible-22d586c5c8ec) thanks Prasad.
+
+# Cognito defender
+Cloud based painless wrapper library to handle authentication via AWS Cognito using JWT capabilities, on backend side, cognito defender has a good integration with express and nest.js framework. 
+
+# Why cognito defender
+
+In the early stages of projects we might to setup the Authentication and Authorisation features to grant access to specific users in the whole system, I wrapped the AWS Cognito identity library to use it on node.js backend and take the advantages to use AWS Cognito 50K first users FREE! 
+
+## What cover cognito defender
+
+- user signing up
+- user sign in
+- forgot password
+- confirm password
+- verify email
+- refresh jwt token
+
+## What is not covering cognito defender
+
+1. MFA Setup: because the library used behind the scenes [AWS Cognito](https://www.npmjs.com/package/amazon-cognito-identity-js) really is made to be used on frontend side, then AWS Cognito require some interactions with the user to enable MFA which is not a good fit for API/Backend technologies.
+
+
+### How to use
+
+- Install it:
+
+```bash
+npm i cognito defender # or yarn add cognito-defender
+```
+
+- Use it
+
+```typescript
+import { CognitoDefender } from "cognito.defender";
+
+const cognitoDefender = new CognitoDefender({
+    regionCognitoPool: 'your-region',
+    cognitoUserPoolId: 'pool-id',
+    cognitoClientId: 'client-id',
+});
+
+const userCreated = await cognitoDefender.login({
+  email: '[email protected]',
+  password: 'super-secret',
+});
+```
+
+
+##### TODO
+- Allow to override payloads.
+- Allow wrap Attributes
+- Methods documentation
+- improvements

src/cognito.defender.ts

@@ -71,6 +71,10 @@ export class CognitoDefender {
     this.pems = bufferPems;
   }
 
+  public getPems(): string {
+    return this.pems;
+  }
+
   public async verifyAccessToken(accessToken: string): Promise<string | PayloadJWTDecoded | undefined> {
     // validate the token
     const decodedJwt: any = jwt.decode(accessToken, { complete: true });