Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 2.32 KB

README.MD

File metadata and controls

57 lines (43 loc) · 2.32 KB

Github API

A Unofficial library for the GitHub API that fetches data from the API.

npm NPM License NPM Downloads Discord

DeepSource DeepSource DeepSource

Installation

To install this package, you can use the following command:

npm install @chethanyadav456/github-api

Usage

To use this package, you can import it as follows:

const GithubAPI = require('@chethanyadav456/github-api');

Searching for user data

To search for user data, you can use the getUser method. This method takes a query string as an argument and returns an array of user objects. For example:

const github = new GithubAPI();
github.getUser('chethanyadav456').then(data => {
  console.log(data);
});

Searching for repositories

To search for repositories, you can use the getRepos method. This method takes a query string as an argument and returns an array of repository objects. For example:

const github = new GithubAPI();
github.getRepos('chethanyadav456').then(data => {
  console.log(data);
});

License

This project is licensed under the MIT license.

Contributing

To contribute to this project, please follow the guidelines in the CONTRIBUTING.md file.

Security Policy

To report a security vulnerability, please use the Security Policy file.

Authors

  • M Chethan Yadav