Skip to content

Commit

Permalink
Merge pull request #3 from arcphysx/feature/add-readme
Browse files Browse the repository at this point in the history
Feature/add readme
arcphysx authored Nov 7, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
2 parents 7cc4d51 + 44e1f15 commit 82a3617
Showing 2 changed files with 65 additions and 1 deletion.
64 changes: 64 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<table align="center">
<tr>
<td>
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
</td>
<td>
<a href="https://www.xendit.co/" target="blank"><img src="https://www.xendit.co/wp-content/uploads/2020/11/xendit-logo-white.svg" height="90" alt="Xendit Logo" /></a>
</td>
</tr>
</table>

<p align="center">
<a href="https://www.npmjs.com/package/nestjs-xendit"><img alt="Package Version" src="https://img.shields.io/npm/v/nestjs-xendit"></a>
<a href="https://www.npmjs.com/package/nestjs-xendit"><img alt="Package License" src="https://img.shields.io/npm/l/nestjs-xendit"></a>
<a><img alt="npm" src="https://img.shields.io/npm/dm/nestjs-xendit"></a>
<a href="https://github.com/arcphysx/nestjs-xendit"><img src="https://github.com/arcphysx/nestjs-xendit/actions/workflows/build.yml/badge.svg?branch=main" alt="Build Project"/></a>
<a href="https://codecov.io/gh/arcphysx/nestjs-xendit"><img src="https://codecov.io/gh/arcphysx/nestjs-xendit/graph/badge.svg?token=9XWUI5O4NI" alt="Coverage"/></a>
<a href="https://app.fossa.com/projects/git%2Bgithub.com%2Farcphysx%2Fnestjs-xendit?ref=badge_shield&issueType=license" alt="FOSSA Status"><img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Farcphysx%2Fnestjs-xendit.svg?type=shield&issueType=license"/></a>
</p>

<br/>

# 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.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": {

0 comments on commit 82a3617

Please sign in to comment.