⚠️ This is currently a work in progress and should not be put into code as none of the features you may see now and in the future are in the package ⚠️

About the module

This is an API that gets GitHub data on users, and so much about them! It allows you to make powerful apps without going through the hassle of getting an auth! Just have the user enter in their GitHub username and you can get simple data about them!

Built with

This is built with typescript

Usage

Obviously, this is a module and we need instructions on how to use it, so the following is on how to use the module!

Installation

To import the module into npm, please do:

npm i git_data-typescript

And you will have succesfuly imported the package! Then in your typescript code:

import * as git from 'git_data-typescript';

Code usage

And you have the module in your code now! Now, let's move on to how to use the function in the module!

Here is a sample on how to get simple data on a user:

import * as git from 'git_data-typescript';
async function getData() {
  let data = await git.getUser("yourGitUsernameHere").readData();
  console.log(data);
}

And then you should see basic(non-sensitive) user data that you can use! But that's not all. We also have a function that allows you to write the data to a file that can be read by ANY other language!

Contributing

Contributing is welcome here! If you feel like contributing, please read our contributing guide!

License

This is a module that is currently under the MIT license, see the license page for more information on how the MIT license is used here.