@specialman/payscribe/README.md

Node JS SDK for Payscribe APIs

<div align="center">

<!--- FIXME: chnage below to name of your project! --->

# `Payscribe NodeJS SDK`

<!--- FIXME: Write short catchy description/tagline of project --->

## Introduction

This guide provides an overview of the Payscribe SDK, including methods for managing accounts, retrieving services, handling customers, processing transactions, and more. The SDK simplifies interactions with the Payscribe API, allowing developers to integrate its functionalities easily.

</div>

## Table of Content

1. [Requirements](#requirements)
2. [Installation](#installation)
3. [Setup](#setup)
4. [Usage](#usage)
5. [Contributing](#contributing)
6. [License](#license)

## Requirements

- Payscribe Public Key.
- Node JS v18 or higher.

## Installation

```sh
npm install @specialman/payscribe
```

## Setup

```javascript
let payscribe = require("@specialman/payscribe");
payscribe = payscribe("your_public_key");
```

# Usage

1. [Responses](documentation/response.md)
2. [Account](documentation/account.md)
3. [Customers](documentation/customer.md)
4. [Betting](documentation/betting.md)
5. [Airtime](documentation/airtime.md)
6. [Misc](documentation/misc.md)

## Contributing

We welcome community contributions to this project.

Please read our [Contributor Guide](CONTRIBUTING.md) for more information on how to get started.
Please also read our [Contributor Terms](CONTRIBUTING.md#contributor-terms) before you make any contributions.

### License

By contributing to this project, you agree that your contributions will be licensed under its [MIT license](/LICENSE).

Copyright (c) Special Man Global Solution LTD.