diff --git a/package.json b/package.json index 3db393f..1de846b 100644 --- a/package.json +++ b/package.json @@ -4,10 +4,7 @@ "description": "Get information for all packages inside of your github organisation", "main": "index.js", "private": false, - "repository": { - "type": "git", - "url": "https://github.com/oleg-koval/github-orgs-packages" - }, + "repository": "oleg-koval/github-orgs-packages", "keywords": [ "github", "repositories", @@ -20,6 +17,7 @@ ], "scripts": { "start": "node index.js", + "generate:markdown": "node ./scripts/markdown.js", "lint": "eslint .", "xyz:increment": "xyz --increment", "release:major": "changelog -M && git add CHANGELOG.md && git commit -m 'Updated CHANGELOG.md' && npm run xyz:increment major", diff --git a/readme.md b/readme.md index f485d96..27f654f 100644 --- a/readme.md +++ b/readme.md @@ -29,8 +29,7 @@ Code: ```js const githubOrgsPackages = require('github-orgs-packages'); -const myOrgPackages = githubOrgsPackages() -myOrgPackages +githubOrgsPackages .then((packages) => { // do smth with packages }) diff --git a/scripts/markdown.js b/scripts/markdown.js new file mode 100644 index 0000000..d898cf9 --- /dev/null +++ b/scripts/markdown.js @@ -0,0 +1,6 @@ +const dependencies = require('../index'); + +return dependencies +.then(deps => { + // ... +})