@clearroad/api

[![Build Status](https://gitlab.com/clearroad/api/badges/master/pipeline.svg)](https://gitlab.com/clearroad/api/commits/master) [![Travis-CI Status](https://travis-ci.org/clearroad/clearroad-api.svg?branch=master)](https://travis-ci.org/clearroad/clearroa

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
027May 19, 2021Aug 29, 2018Minified + gzip package size for @clearroad/api in KB

Readme

ClearRoad API SDK

Build Status Travis-CI Status Coverage Status Conventional Commits npm version PRs Welcome


Getting Started

Follow the Getting Started guide. You can use the ClearRoad API SDK on web applications written in JavaScript, but also on Node.js. You can find examples for both below.

Examples

Node.js

You can find the following samples using the ClearRoad API SDK with node:

Full documentation

The full documentation for ClearRoad API SDK can be found on our website. The source for the documentation and website is in the guide folder.

The ClearRoad API SDK documentation only discusses the APIs of the SDK. For further documentation on use-cases of the API or to test out the API, refer to the API Documentation.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.