pancake-sms v0.0.1

Table of Contents

• Example Usage
• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
  • Documentation
• Contributing
• License

Usage

const {SMSClient} = require('../dist/index');
const client = new SMSClient(
    {
        email: {
            "service": "gmail",
            "auth": {
                "user": "email@domain.com",
                "pass": "password"
            }
        }
    });

client.send({
    pnumber: "7166048061",
    text: "this is a test text message",
    carrier: "verizon",
    region: "US"
});

About

pancake is an outgoing SMS library and API. It allows you to send texts via Vtext to numerous mobile carriers in various regions. One of the packages include an example of an outgoing SMS express server.

Built With

• nodemailer - Send emails to vtext addresses

Getting Started

Prerequisites

You are expected to have an updated version of node.js. Pancake is tested on node.js >12.0.0 and we make no guarantees that it will work on earlier versions. The target ES version intended is ES5.

Installation

1. Install through NPM (recommended)

• npm install pancake-sms

2. Clone the repo and build

• git clone https://github.com/zaida04/pancake
• cd pancake
• npm i
• npm build

Then proceed to move the related dirs to your node_modules

Documentation

Documentation will be coming once the project is at a usable state.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Please ensure your commits pass the tests, lints, and builds. This means you should test it locally before pushing.

LICENSING

pancake © zaida04, Released under the MIT License.