Skip to content

Commit

Permalink
docs(readme): add installation section
Browse files Browse the repository at this point in the history
  • Loading branch information
deltaidea committed May 5, 2016
1 parent 265a9a9 commit 328b486
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

An alternative library for interacting with vk.com with solid and exceptionally convenient API.

## Install

The driver is packaged as an [UMD](https://github.com/umdjs/umd) and is published to:

- [NPM](https://www.npmjs.com/package/@vk-x/vk-api): `npm install --save @vk-x/vk-api`
- [Bower](http://bower.io/search/?q=vk-api): `bower install vk-api`
- [jsDelivr CDN](http://www.jsdelivr.com/projects/vk-api): `https://cdn.jsdelivr.net/vk-api/latest/vk-api.min.js`
- A smaller version without method shortcuts is also available: `https://cdn.jsdelivr.net/vk-api/latest/vk-api-no-shortcuts.min.js`

## Use

After you've included and loaded the script, you can use it either with Promises or with callbacks.

```JavaScript

// Authenticate on your website.
Expand Down

0 comments on commit 328b486

Please sign in to comment.