Skip to content

Latest commit

 

History

History
70 lines (42 loc) · 1.17 KB

README.md

File metadata and controls

70 lines (42 loc) · 1.17 KB

IVAO.js

Ivao.js is a module that incorporates the entire IVAO api. This module can be used with an api key and with the new oauth2 system.

NOTE: Versions below 1.9.0 do not work!

Installation

Install my-project with npm

  npm install ivao.js
  cd my-project

OAuth 2.0

To obtain access to the new oauth system, please follow the HQ documentation.

Usage/Examples

With APIKey:

import { Client } from 'ivao.js/lib';

const client = new Client({
    type: 'apiKey',
    apiKey: 'YOUR_API_KEY'
});

With OAuth2.0:

import { Client } from 'ivao.js/lib';

const client = new Client({
    type: 'oauth2',
    client_id: 'YOUR_CLIENT_ID',
    secret_id: 'YOUR_SECRET_ID'
});

Roadmap

  • Add more routes

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

License

GPL-2.0

Authors