Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 2.47 KB

README.md

File metadata and controls

63 lines (43 loc) · 2.47 KB
Raw

node-sendle

Build Status npm version Dependencies npm downloads code style: prettier License: MIT

Sendle Node.js library

In order to use this library, you need to have an account on https://www.sendle.com/. After registering, you will need the application credentials for your app.

Supported platforms

This SDK supports Node.js version 14+.

We test the library against a selection of Node.js versions which we update over time. Please refer to main.yml for the set of versions that are currently tested with CI.

If you find any compatibility issues, please raise an issue in the repository.

Installation

You need to be running at least Node.js 14 to use this library.

$ yarn add sendle-node

Create a client

import { SendleClient } from 'sendle-node';

const client = new SendleClient({
  sendleId: 'yourSendleId',
  apiKey: 'yourApiKey',
  sandbox: true, // default to false
  gotOptions: {}, // See https://github.com/sindresorhus/got#api
});

See the docs for usage reference.

Development

  1. Clone this repository
  2. Install dependencies using yarn install or npm install
  3. Build the module using yarn build or npm run build
  4. Start development server using yarn start or npm run start

📑 License

MIT License