CLI util for generating a GitHub project information file.
The main purpose of creating a package is to save on the number of requests to the GitHub GraphQL API to get information about the repository (for example, to display packages on your website)
npm install ghinfo --save-dev
ghinfo generate -d media -t utils
Generate .ghinfo
with logo, social-preview and package description:
{
"name": "ghinfo",
"version": "2.0.3",
"description": "CLI util for generating a GitHub project information file",
"keywords": ["automated", "repo", "info", "cli", "github", "util"],
"repo": "keindev/ghinfo",
"type": "utils",
"links": {
"git": "https://github.com/keindev/ghinfo",
"npm": "https://www.npmjs.com/package/ghinfo",
"homepage": "https://github.com/keindev/ghinfo#readme"
},
"files": {
"logo": "media/logo.svg",
"social-preview": "media/social-preview.png"
}
}
Read the API documentation for more information.