docs: updating readme file

Author: jarrodek

README.md

@@ -10,41 +10,42 @@ This module is mainly used in the [@api-components/api-console-builder](https://
 
 Shorthand functions:
 
--   `latestInfo(logger)` -> `new ApiConsoleGithubResolver#getLatestInfo()`
--   `tagInfo(tag, logger)` -> `new ApiConsoleGithubResolver#getTagInfo(tag)`
--   `releasesInfo(logger)` -> `new ApiConsoleGithubResolver#getReleasesList()`
+-   `latestInfo(logger)` -> `new GithubResolver#getLatestInfo()`
+-   `tagInfo(tag, logger)` -> `new GithubResolver#getTagInfo(tag)`
+-   `releasesInfo(logger)` -> `new GithubResolver#getReleasesList()`
 
-The module exposes 2 classes:
+The module exposes 4 classes:
 
--   [ApiConsoleTransport](lib/transport.js)
--   [ApiConsoleGithubResolver](lib/github-resolver.js)
+-   [Transport](lib/Transport.js)
+-   [GithubResolver](lib/GithubResolver.js)
+-   [GithubResolverOptions](lib/GithubResolverOptions.js)
+-   [GithubCache](lib/GithubCache.js)
 
 ### Example
 
 ```javascript
-const resolver = require('api-console-github-resolver');
+import { latestInfo } from '@api-components/api-console-github-resolver';
 
-resolver.latestInfo(winstonLogger)
-.then(info => console.log(info))
-.catch(cause => console.error(cause));
+const winstonLogger = new winston.createLogger({...});
+const info = await latestInfo(winstonLogger);
+console.log(info);
 ```
 
 equivalent to
 
 ```javascript
-const {ApiConsoleGithubResolver} = require('api-console-github-resolver');
+import { GithubResolver }  from '@api-components/api-console-github-resolver';
 
-const resolver = new ApiConsoleGithubResolver({
+const resolver = new GithubResolver({
   logger: winstonLogger
 });
-resolver.getLatestInfo()
-.then(info => console.log(info))
-.catch(cause => console.error(cause));
+const info = await resolver.getLatestInfo();
+console.log(info);
 ```
 
-### ApiConsoleTransport
+### Transport
 
-GitGub transport class.
+GitHub transport class.
 The transport is based on the HTTPS protocol.
 
 #### `get(resource, headers)`
@@ -57,21 +58,20 @@ Gets a resource from given location. This function fallows redirects.
 
 ##### Returns `<Promise>`
 
-A promise resolved to a JavaScript `Object` if compatible content type is detected
-or to `Buffer` otherwise.
+A promise resolved to a JavaScript `Object` if compatible content type is detected or to `Buffer` otherwise.
 
 #### Example
 
 ```javascript
-const {ApiConsoleTransport} = require('api-console-github-resolver');
-const winston = require('winston');
-const transport = new ApiConsoleTransport(createLogger(winston));
-transport.get('https://...', {'etag': 'abc'})
-.then((response) => console.log(response))
-.catch((cause) => console.error(response));
+import { Transport } from '@api-components/api-console-github-resolver';
+
+const winstonLogger = new winston.createLogger({...});
+const transport = new Transport(winstonLogger);
+const response = await transport.get('https://...', {'etag': 'abc'});
+console.log(response);
 ```
 
-### ApiConsoleGithubResolver
+### GithubResolver
 
 A class to resolve GitHub repositories versions. It allows to get latest release
 version and the url to the release's zip file or list available versions.
@@ -110,16 +110,16 @@ GitHub allows to make up to 60 requests per hour. To increate the limit you can
 use [GitHub personal token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) as an option passed to the `ApiConsoleGithubResolver` class constructor.
 
 ### Example
+
 ```javascript
-const {ApiConsoleGithubResolver} = require('api-console-github-resolver');
+import { GithubResolver } from '@api-components/api-console-github-resolver';
 
-const TOKEN = 'ABCx';
-const resolver = new ApiConsoleGithubResolver({
+const TOKEN = 'ABC';
+const resolver = new GithubResolver({
   token: TOKEN
 });
-resolver.getLatestInfo()
-.then(info => console.log(info))
-.catch(cause => console.error(cause));
+const info = await resolver.getLatestInfo();
+console.log(info);
 ```
 
 Module's shorthand functions reads `GITHUB_TOKEN` environmental variable and
@@ -129,14 +129,13 @@ sets it as a configuration option by default.
 
 ```javascript
 // index.js
-const resolver = require('api-console-github-resolver');
+import { latestInfo } from '@api-components/api-console-github-resolver';
 
-resolver.latestInfo()
-.then(info => console.log(info))
-.catch(cause => console.error(cause));
+const info = await latestInfo();
+console.log(info);
 ```
 
 ```shell
-$ export GITHUB_TOKEN="ABCx"
+$ export GITHUB_TOKEN="ABC"
 $ node index.js
 ```