diff --git a/README.md b/README.md new file mode 100644 index 0000000..3a520d5 --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ + + + + + +
+ Nest Logo + + Xendit Logo +
+ +

+ Package Version + Package License + npm + Build Project + Coverage + +

+ +
+ +# NestJS Xendit + +A [Xendit Node SDK](https://www.xendit.co/) wrapper for [NestJS framework](http://nestjs.com/) + +**THIS IS NOT AN OFFICIAL PACKAGE FROM XENDIT OR NESTJS** + +## Installation +NPM: +```bash +npm i --save nestjs-xendit +``` + +Yarn: +```bash +yarn add nestjs-xendit +``` + +## Usage/Examples +Sync: +```js +XenditModule.register({ + secretKey: "XENDIT_KEY" +}) +``` + +Async: +```js +XenditModule.registerAsync({ + useFactory: (configService: ConfigService) =>{ + return { + secretKey: configService.get('XENDIT_KEY') + } + }, + inject: [ConfigService] +}) +``` + +## Contributing + +Contributions are always welcome! + +Feel free to patch / edit / optimize / add features. PR are Welcome. \ No newline at end of file diff --git a/package.json b/package.json index 403f40b..a4294ae 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "nestjs-xendit", - "version": "0.1.0", + "version": "0.1.1", "description": "NestJS Package wrapper for xendit-node package", "main": "dist/index.js", "scripts": {