From 328b486e3e68fd677ab4fecade89f7e0c30d8284 Mon Sep 17 00:00:00 2001 From: Nikita Litvin Date: Thu, 5 May 2016 23:16:55 +0500 Subject: [PATCH] docs(readme): add installation section --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 9041a4d..48b0bac 100644 --- a/README.md +++ b/README.md @@ -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.