Skip to content
This repository has been archived by the owner on Jan 20, 2024. It is now read-only.

Commit

Permalink
Updating readme page
Browse files Browse the repository at this point in the history
  • Loading branch information
jarrodek committed Jan 1, 2019
1 parent 6887765 commit 0666ba5
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ 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 ApiConsoleGithubResolver#getLatestInfo()`
- `tagInfo(tag, logger)` -> `new ApiConsoleGithubResolver#getTagInfo(tag)`
- `releasesInfo(logger)` -> `new ApiConsoleGithubResolver#getReleasesList()`

The module exposes 2 classes:

Expand All @@ -24,7 +24,7 @@ The module exposes 2 classes:
```javascript
const resolver = require('api-console-github-resolver');

resolver.latestInfo([winstonLogger])
resolver.latestInfo(winstonLogger)
.then(info => console.log(info))
.catch(cause => console.error(cause));
```
Expand Down

0 comments on commit 0666ba5

Please sign in to comment.