@specialman/termii/README.md

Node JS SDK for Termii APIs

<div align="center">

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

# `Termii NodeJS SDK`

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

The Termii SDK provides a seamless way to integrate messaging, token, and insights into your applications. This guide explains how to use the available features, including sending messages, verifying phone numbers, checking balances and more.

</div>

## Table of Content

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

## Requirements

- Termii API key.
- Node JS v18 or higher.

## Installation

```sh
npm install @specialman/termii
```

## Setup

```javascript
let termii = require("@specialman/termii");
termii = termii("your_api_key");
```

# Usage

1. [Error](documentation/error.md)
2. [Messaging](documentation/messaging.md)
3. [Token](documentation/token.md)
4. [Insight](documentation/insight.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.