open-index/open-npm huggingface dataset:
npm package: @ggyteams/teams_design
Description: A react library developed with dumi
Latest version: 0.0.1

# @ggyteams/teams_design

[![NPM version](https://img.shields.io/npm/v/@ggyteams/teams_design.svg?style=flat)](https://npmjs.org/package/@ggyteams/teams_design)
[![NPM downloads](http://img.shields.io/npm/dm/@ggyteams/teams_design.svg?style=flat)](https://npmjs.org/package/@ggyteams/teams_design)

A react library developed with dumi

## Usage

TODO

## Options

TODO

## Development

```bash
# install dependencies
$ pnpm install

# develop library by docs demo
$ pnpm start

# build library source code
$ pnpm run build

# build library source code in watch mode
$ pnpm run build:watch

# build docs
$ pnpm run docs:build

# Locally preview the production build.
$ pnpm run docs:preview

# check your project for potential problems
$ pnpm run doctor
```

## LICENSE

MIT
npm package: @ggyteams/teams_im_ui
Description: A react library developed with dumi
Latest version: 0.4.7

# @ggyteams/teams_im_ui

[![NPM version](https://img.shields.io/npm/v/@ggyteams/teams_im_ui.svg?style=flat)](https://npmjs.org/package/@ggyteams/teams_im_ui)
[![NPM downloads](http://img.shields.io/npm/dm/@ggyteams/teams_im_ui.svg?style=flat)](https://npmjs.org/package/@ggyteams/teams_im_ui)

A react library developed with dumi

## Usage

TODO

## Options

TODO

## Development

```bash
# install dependencies
$ pnpm install

# develop library by docs demo
$ pnpm start

# build library source code
$ pnpm run build

# build library source code in watch mode
$ pnpm run build:watch

# build docs
$ pnpm run docs:build

# check your project for potential problems
$ pnpm run doctor
```

## LICENSE

MIT
npm package: @ggyuhooks/use-title
Description: React Hook to update your document's title
Author: ggyu720
Latest version: 1.0.1

React Hook to update your document's title.

## Installation

#### yarn

`yarn add @ggyuhooks/use-title`

#### npm

`npm i @ggyuhooks/use-title`

## Usage

```js
import React from "react";
import useTitle from "@ggyuhooks/use-title";
function App() {
  useTitle("Welcome");
  return <h1>Welcome</h1>;
}
```

### Arguments

| Argument | Type   | Description                                | Required |
| -------- | ------ | ------------------------------------------ | -------- |
| title    | string | The title you want to use on your document | yes      |
npm package: @gh-conf/gh-api
Description: Github apis used by gh-conf repositories
Author: Arshad Kazmi
Latest version: 1.1.2

# gh-api

[![Build](https://travis-ci.com/gh-conf/gh-api.svg?branch=master)](https://travis-ci.com/gh-conf/gh-api/)

Github api module, used by gh-conf repositories

## Install

```
npm install @gh-conf/gh-api
```

## Usage

```js
const { Contributors, ParentRepo } = require('@gh-conf/gh-api');

const username = 'arshadkazmi42';
const repository = 'strmat';
const forkedRepo = 'taskcluster';

// Fetches list of contributors of the repository
const contributors = await Contributors(username, respository);

// Output
/**
 [
  {
    'avatar_url': 'https://avatars3.githubusercontent.com/u/4654382?v=4',
    'contributions': 9,
    'events_url': 'https://api.github.com/users/arshadkazmi42/events{/privacy}',
    'followers_url': 'https://api.github.com/users/arshadkazmi42/followers',
    'following_url': 'https://api.github.com/users/arshadkazmi42/following{/other_user}',
    'gists_url': 'https://api.github.com/users/arshadkazmi42/gists{/gist_id}',
    'gravatar_id': '',
    'html_url': 'https://github.com/arshadkazmi42',
    'id': 4654382,
    'login': 'arshadkazmi42',
    'node_id': 'MDQ6VXNlcjQ2NTQzODI=',
    'organizations_url': 'https://api.github.com/users/arshadkazmi42/orgs',
    'received_events_url': 'https://api.github.com/users/arshadkazmi42/received_events',
    'repos_url': 'https://api.github.com/users/arshadkazmi42/repos',
    'site_admin': false,
    'starred_url': 'https://api.github.com/users/arshadkazmi42/starred{/owner}{/repo}',
    'subscriptions_url': 'https://api.github.com/users/arshadkazmi42/subscriptions',
    'type': 'User',
    'url': 'https://api.github.com/users/arshadkazmi42',
  }
];
**/


// Fetches upstream url of the repository from parent repository
const upstream = await ParentRepo(username, forkedRepo);

// Output
// https://github.com/taskcluster/taskcluster

```

## API

#### `contributors`

- Fetches list of all contibutors of the repository
- Input: username, repository

#### `parentRepo`

- Fetches parent repository url
- Input: username, repository

## Contributing

Interested in contributing to this project?
You can log any issues or suggestion related to this library [here](https://github.com/gh-conf/gh-api/issues/new).

Read our contributing [guide](CONTRIBUTING.md) to get started with contributing to the codebase.

## Contributors

Thank you to all the contributors who have helped us in making this project better 🙌

<a href="https://github.com/arshadkazmi42"><img src="https://github.com/arshadkazmi42.png" width="30" /></a><a href="https://github.com/wdmcquinn"><img src="https://github.com/wdmcquinn.png" width="30" /></a>
npm package: @gh-conf/gh-conf-constants
Description: Constants for gh-conf
Author: Arshad Kazmi
Latest version: 1.0.9

# gh-conf-constants

[![Build](https://github.com/gh-conf/gh-conf-constants/actions/workflows/nodejs.yml/badge.svg)](https://github.com/gh-conf/gh-conf-constants/actions/workflows/nodejs.yml)
[![Contributors](https://img.shields.io/github/contributors/gh-conf/gh-conf-constants.svg)](https://github.com/gh-conf/gh-conf-constants/graphs/contributors)
[![Commit](https://img.shields.io/github/last-commit/gh-conf/gh-conf-constants.svg)](https://github.com/gh-conf/gh-conf-constants/commits/master)
[![Github Repo Size](https://img.shields.io/github/repo-size/gh-conf/gh-conf-constants.svg)](https://github.com/gh-conf/gh-conf-constants)
[![LICENSE](https://img.shields.io/npm/l/@gh-conf/gh-conf-constants.svg)](https://github.com/gh-conf/gh-conf-constants/LICENSE)
[![NPM Downloads](https://img.shields.io/npm/dt/@gh-conf/gh-conf-constants.svg)](https://www.npmjs.com/package/@gh-conf/gh-conf-constants)
[![NPM Version](https://img.shields.io/npm/v/@gh-conf/gh-conf-constants.svg)](https://www.npmjs.com/package/@gh-conf/gh-conf-constants)

Constants for gh-conf.

> Give us a :star: if you like our work :heart:

## Install

```
$ npm install @gh-conf/gh-conf-constants
```

## Usage

```javascript
const { GH_PATH } = require('@gh-conf/gh-conf-constants');

console.log(GH_PATH['CONFIG'])
// Output
// .git/config


```

## Contributing

Interested in contributing to this project?
You can log any issues or suggestion related to this library [here](https://github.com/gh-conf/gh-conf-constants/issues/new)

Read our contributing [guide](CONTRIBUTING.md) on getting started with contributing to the codebase
npm package: @gh-conf/gh-conf-parse
Description: Parser to parse details from github config
Author: Arshad Kazmi
Latest version: 1.1.0

# gh-conf-parse

[![Build](https://github.com/gh-conf/gh-conf-parse/actions/workflows/nodejs.yml/badge.svg)](https://github.com/gh-conf/gh-conf-parse/actions/workflows/nodejs.yml)
[![Github Repo Size](https://img.shields.io/github/repo-size/gh-conf/gh-conf-parse.svg)](https://github.com/gh-conf/gh-conf-parse)
[![LICENSE](https://img.shields.io/npm/l/@gh-conf/gh-conf-parse.svg)](https://github.com/gh-conf/gh-conf-parse/LICENSE)
[![NPM Downloads](https://img.shields.io/npm/dt/@gh-conf/gh-conf-parse.svg)](https://www.npmjs.com/package/@gh-conf/gh-conf-parse)
[![NPM Version](https://img.shields.io/npm/v/@gh-conf/gh-conf-parse.svg)](https://www.npmjs.com/package/@gh-conf/gh-conf-parse)
[![Contributors](https://img.shields.io/github/contributors/gh-conf/gh-conf-parse.svg)](https://github.com/gh-conf/gh-conf-parse/graphs/contributors)
[![Commit](https://img.shields.io/github/last-commit/gh-conf/gh-conf-parse.svg)](https://github.com/gh-conf/gh-conf-parse/commits/master)

Parser for parsing information from github config file

## Install

```
npm install @gh-conf/gh-conf-parse
```

## Usage

```js
const { ParseConfig, UserRepo } = require('@gh-conf/gh-conf-parse');

const CurrConfig = ParseConfig();

// Output
// {
//    core:{
//       repositoryformatversion:'0',
//       filemode:'true',
//       bare:'false',
//       logallrefupdates:'true',
//       ignorecase:'true',
//       precomposeunicode:'true'
//    },
//    'remote "origin"':{
//       url:'https://github.com/gh-conf/gh-conf-parse.git',
//       fetch:'+refs/heads/*:refs/remotes/origin/*'
//    },
//    'branch "master"':{
//       remote:'origin',
//       merge:'refs/heads/master'
//    }
// }


const userRepo = UserRepo();

// Output
// {
//   repository:'gh-conf-parse',
//   username:'gh-conf'
// }

```

## API

#### `ParseConfig`

- Returns complete git config as JSON

#### `UserRepo`

- Returns repo owner name and repository name

## Contributing

Interested in contributing to this project?
You can log any issues or suggestion related to this library [here](https://github.com/gh-conf/gh-conf-parse/issues/new).

Read our contributing [guide](CONTRIBUTING.md) to get started with contributing to the codebase.

## Contributors

Thank you to all the contributors who have helped us in making this project better 🙌

<a href="https://github.com/arshadkazmi42"><img src="https://github.com/arshadkazmi42.png" width="30" /></a>
npm package: @gh-conf/gh-conf-path
Description: Builds & Formats input path
Author: Arshad Kazmi
Latest version: 1.0.3

# gh-conf-path

Builds and formats input path

[![Build Status](https://travis-ci.com/gh-conf/gh-conf-path.svg?branch=master)](https://travis-ci.com/gh-conf/gh-conf-path)
[![Github Repo Size](https://img.shields.io/github/repo-size/gh-conf/gh-conf-path.svg)](https://github.com/gh-conf/gh-conf-path)
[![Contributors](https://img.shields.io/github/contributors/gh-conf/gh-conf-path.svg)](https://github.com/gh-conf/gh-conf-path/graphs/contributors)
[![Commit](https://img.shields.io/github/last-commit/gh-conf/gh-conf-path.svg)](https://github.com/gh-conf/gh-conf-path/commits/master)


It reads the github config file and returns it contents.
It needs respository path as input to read the config.

> Give us a :star: if you like our work :heart:

<a href="https://www.buymeacoffee.com/gh-conf" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
<a href="https://www.patreon.com/bePatron?u=15454240" target="_blank"><img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" alt="Become a Patron!" height="40"></a>

Please consider donating, if you like my work

## Install

```
$ npm install @gh-conf/gh-conf-path
```

## Usage

```javascript
const { addSlash } = require('@gh-conf/gh-conf-path');

const path = addSlash('./gh-conf-path');
console.log(path)
// Output
// ./gh-conf-path/

```

## Contributing

Interested in contributing to this project?
You can log any issues or suggestion related to this library [here](https://github.com/gh-conf/gh-conf-path/issues/new)

Read our contributing [guide](CONTRIBUTING.md) on getting started with contributing to the codebase

## Contributors

<a href="https://github.com/arshadkazmi42"><img src="https://github.com/arshadkazmi42.png" width="30" /></a>
npm package: @gh-conf/gh-conf-read
Description: Reads github config file
Author: Arshad Kazmi
Latest version: 1.1.3

# gh-conf-read

[![Build Status](https://travis-ci.com/gh-conf/gh-conf-read.svg?branch=master)](https://travis-ci.com/gh-conf/gh-conf-read)
[![Github Repo Size](https://img.shields.io/github/repo-size/gh-conf/gh-conf-read.svg)](https://github.com/gh-conf/gh-conf-read)
[![Contributors](https://img.shields.io/github/contributors/gh-conf/gh-conf-read.svg)](https://github.com/gh-conf/gh-conf-read/graphs/contributors)
[![Commit](https://img.shields.io/github/last-commit/gh-conf/gh-conf-read.svg)](https://github.com/gh-conf/gh-conf-read/commits/master)
[![NPM Version](https://img.shields.io/npm/v/@gh-conf/gh-conf-read.svg)](https://www.npmjs.com/package/@gh-conf/gh-conf-read)

It reads the github config file and returns it contents.
It needs respository path as input to read the config.

> Give us a :star: if you like our work :heart:

<a href="https://www.buymeacoffee.com/gh-conf" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
<a href="https://www.patreon.com/bePatron?u=15454240" target="_blank"><img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" alt="Become a Patron!" height="40"></a>

Please consider donating, if you like my work

## Install

```
$ npm install @gh-conf/gh-conf-read
```

## Usage

```javascript
const { readConf } = require('@gh-conf/gh-conf-read');

(async () => {
  try {
    const configContent = await readConf('./gh-conf-read');
    console.log(configContent);
    /**
     * [core]
     *     repositoryformatversion = 0
     *     filemode = true
     *     bare = false
     *     logallrefupdates = true
     * [remote "origin"]
     *     url = git@github.com:gh-conf/gh-conf-read
     *     fetch = +refs/heads/*:refs/remotes/origin/*
     * [branch "master"]
     *   remote = origin
     *   merge = refs/heads/master
     * [user]
     *     name = Arshad Kazmi
     *     email = arshadkazmi42@gmail.com
     **/
  } catch (error) {
    console.log(error);
  }
})();



```

## Contributing

Interested in contributing to this project?
You can log any issues or suggestion related to this library [here](https://github.com/gh-conf/gh-conf-read/issues/new)

Read our contributing [guide](CONTRIBUTING.md) on getting started with contributing to the codebase

## Contributors

Thank you to all the contributors who have helped us in making this project better :raised_hands:

<a href="https://github.com/arshadkazmi42"><img src="https://github.com/arshadkazmi42.png" width="30" /></a><a href="https://github.com/oshanz"><img src="https://github.com/oshanz.png" width="30" /></a><a href="https://github.com/aldyadk"><img src="https://github.com/aldyadk.png" width="30" /></a><a href="https://github.com/p85"><img src="https://github.com/p85.png" width="30" /></a>
npm package: @gh-conf/gh-conf-response
Description: gh-conf response builder
Author: Arshad Kazmi
Latest version: 1.0.6

# gh-conf-response

[![Build](https://github.com/gh-conf/gh-conf-response/actions/workflows/nodejs.yml/badge.svg)](https://github.com/gh-conf/gh-conf-response/actions/workflows/nodejs.yml)
[![NPM Version](https://img.shields.io/npm/v/@gh-conf/gh-conf-response.svg)](https://www.npmjs.com/package/@gh-conf/gh-conf-response)
[![NPM Downloads](https://img.shields.io/npm/dt/@gh-conf/gh-conf-response.svg)](https://www.npmjs.com/package/@gh-conf/gh-conf-response)
[![Github Repo Size](https://img.shields.io/github/repo-size/gh-conf/gh-conf-response.svg)](https://github.com/gh-conf/gh-conf-response)
[![LICENSE](https://img.shields.io/npm/l/@gh-conf/gh-conf-response.svg)](https://github.com/gh-conf/gh-conf-response/blob/master/LICENSE)
[![Contributors](https://img.shields.io/github/contributors/gh-conf/gh-conf-response.svg)](https://github.com/gh-conf/gh-conf-response/graphs/contributors)
[![Commit](https://img.shields.io/github/last-commit/gh-conf/gh-conf-response.svg)](https://github.com/gh-conf/gh-conf-response/commits/master)

Response builder for gh-conf libraries

> Give us a :star: if you like our work :heart:

## Install

```
$ npm install @gh-conf/gh-conf-response
```

## Usage

```javascript
const { formatError, formatSuccess } = require("@gh-conf/gh-conf-response");

const successResponse = formatSuccess("Successfully passed", {
  name: "formatSuccess",
});
console.log(successResponse);
// Output
/**
 * {
 *  status: 'success',
 *  message: 'Successfully passed',
 *  data: {
 *    name: 'formatSuccess'
 *  }
 * }
 **/

const errorResposne = formatError("Error running tests", { err: "101" });
console.log(successResponse);
// Output
/**
 * {
 *  status: 'err',
 *  message: 'Error running tests',
 *  data: {
 *    err: '101'
 *  }
 * }
 **/
```

## Contributing

Interested in contributing to this project?
You can log any issues or suggestion related to this library [here](https://github.com/gh-conf/gh-conf-response/issues/new)

Read our contributing [guide](CONTRIBUTING.md) on getting started with contributing to the codebase
npm package: @gh-conf/gh-conf-validate
Description: Vaidator for gh-conf libraries
Author: Arshad Kazmi
Latest version: 1.0.5

# gh-conf-validate

[![npm (scoped)](https://img.shields.io/npm/v/@gh-conf/gh-conf-validate)](https://www.npmjs.com/package/@gh-conf/gh-conf-validate)
[![Build](https://github.com/gh-conf/gh-conf-validate/actions/workflows/nodejs.yml/badge.svg)](https://github.com/gh-conf/gh-conf-validate/actions/workflows/nodejs.yml)
[![Github Repo Size](https://img.shields.io/github/repo-size/gh-conf/gh-conf-validate.svg)](https://github.com/gh-conf/gh-conf-validate)
[![npm](https://img.shields.io/npm/dt/@gh-conf/gh-conf-validate)](https://www.npmjs.com/package/@gh-conf/gh-conf-validate)
[![GitHub](https://img.shields.io/github/license/gh-conf/gh-conf-validate)](https://github.com/gh-conf/gh-conf-validate/blob/master/LICENSE)
[![Contributors](https://img.shields.io/github/contributors/gh-conf/gh-conf-validate.svg)](https://github.com/gh-conf/gh-conf-validate/graphs/contributors)
[![Commit](https://img.shields.io/github/last-commit/gh-conf/gh-conf-validate.svg)](https://github.com/gh-conf/gh-conf-validate/commits/master)

Github config libraries validator

> Give us a :star: if you like our work :heart:

<a href="https://www.buymeacoffee.com/gh-conf" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
<a href="https://www.patreon.com/bePatron?u=15454240" target="_blank"><img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" alt="Become a Patron!" height="40"></a>

Please consider donating, if you like my work

## Install

```
$ npm install @gh-conf/gh-conf-validate
```

## Usage

```javascript
const { validatePath } = require('@gh-conf/gh-conf-validate');

// Valid path
const isValid = validatePath('./gh-conf-validate');
console.log(isValid);
// Output
// true

// Invalid path
try {
  validatePath();
} catch (err) {
  console.log(err);

  // Output
  /**
  * {
  *   status: 'err',
  *   message: 'No path input',
  *   data: {}
  * }
  **/
}
```

## Contributing

Interested in contributing to this project?
You can log any issues or suggestion related to this library [here](https://github.com/gh-conf/gh-conf-validate/issues/new)

Read our contributing [guide](CONTRIBUTING.md) on getting started with contributing to the codebase

## Contributors

Thank you to all the contributors who have helped us in making this project better 🙌
npm package: @gh-conf/gh-conf-write
Description: Writes to github config
Author: Arshad Kazmi
Latest version: 1.1.2

# gh-conf-write

Write content to github config file

[![Build Status](https://travis-ci.com/gh-conf/gh-conf-write.svg?branch=master)](https://travis-ci.com/gh-conf/gh-conf-write)
[![Github Repo Size](https://img.shields.io/github/repo-size/gh-conf/gh-conf-write.svg)](https://github.com/gh-conf/gh-conf-write)
[![Contributors](https://img.shields.io/github/contributors/gh-conf/gh-conf-write.svg)](https://github.com/gh-conf/gh-conf-write/graphs/contributors)
[![Commit](https://img.shields.io/github/last-commit/gh-conf/gh-conf-write.svg)](https://github.com/gh-conf/gh-conf-write/commits/master)
[![NPM Version](https://img.shields.io/npm/v/@gh-conf/gh-conf-write.svg)](https://www.npmjs.com/package/@gh-conf/gh-conf-write)

It reads the github config file and returns it contents.
It needs respository path as input to read the config.

> Give us a :star: if you like our work :heart:

<a href="https://www.buymeacoffee.com/gh-conf" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
<a href="https://www.patreon.com/bePatron?u=15454240" target="_blank"><img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" alt="Become a Patron!" height="40"></a>

Please consider donating, if you like my work


## Install

```
$ npm install @gh-conf/gh-conf-write
```


## Usage

```javascript
const { writeConf } = require('@gh-conf/gh-conf-write');

(async () => {
  try {
    const writeResult = await writeConf('./gh-conf-write', 'CONTENT');
    console.log(writeResult);
    /**
     * {
     *   status: 'success',
     *   message: 'Config updated',
     *   data: {
     *       content: 'CONTENT'
     *   }
     * }
     **/
  } catch (error) {
    console.log(error);
  }
})();

```


## Contributing

Interested in contributing to this project?
You can log any issues or suggestion related to this library [here](https://github.com/gh-conf/gh-conf-write/issues/new)

Read our contributing [guide](CONTRIBUTING.md) on getting started with contributing to the codebase


## Contributors

<a href="https://github.com/arshadkazmi42"><img src="https://github.com/arshadkazmi42.png" width="30" /></a>  <a href="https://github.com/justingolden21"><img src="https://github.com/justingolden21.png" width="30" /></a>  <a href="https://github.com/bojanadjordjevic"><img src="https://github.com/bojanadjordjevic.png" width="30" /></a>  <a href="https://github.com/myles-painter"><img src="https://github.com/myles-painter.png" width="30" /></a>
npm package: @gh-conf/rhof
Description: Fetches all the contributors of a github repository and generates HOF for the readme file
Author: Arshad Kazmi
Latest version: 1.1.0

# rhof

[![Build](https://github.com/gh-conf/rhof/actions/workflows/nodejs.yml/badge.svg)](https://github.com/gh-conf/rhof/actions/workflows/nodejs.yml)
[![NPM Version](https://img.shields.io/npm/v/rhof.svg)](https://www.npmjs.com/package/rhof)
[![NPM Downloads](https://img.shields.io/npm/dt/rhof.svg)](https://www.npmjs.com/package/rhof)
[![Github Repo Size](https://img.shields.io/github/repo-size/gh-conf/rhof.svg)](https://github.com/gh-conf/rhof)
[![LICENSE](https://img.shields.io/npm/l/rhof.svg)](https://github.com/gh-conf/rhof/blob/master/LICENSE)
[![Contributors](https://img.shields.io/github/contributors/gh-conf/rhof.svg)](https://github.com/gh-conf/rhof/graphs/contributors)
[![Commit](https://img.shields.io/github/last-commit/gh-conf/rhof.svg)](https://github.com/gh-conf/rhof/commits/master)

Fetch contributors list of github repository and generate hall of fame for github readme

## Install

```
$ npm i @gh-conf/rhof
```

## Usage

```javascript

const rhof = require('@gh-conf/rhof');

(async () => {
  try {
    const username = 'arshadkazmi42'; //github username
    const repository = 'gh-rhof'; // github repository name
    const hof = await rhof(username, repository);
    console.log(hof);
    // <a href='https://github.com/arshadkazmi42'><img src="https://github.com/arshadkazmi42.png" width="30" /></a>
  } catch (error) {
    console.log(error);
  }
})();


```


## Contributing

Interested in contributing to this project?
You can log any issues or suggestion related to this library [here](https://github.com/gh-conf/rhof/issues/new)

Read our contributing [guide](CONTRIBUTING.md) on getting started with contributing to the codebase
npm package: @gh-conf/upstream-core
Description: Upstreamit core engine
Author: Arshad Kazmi
Latest version: 1.0.2

# upstream-core

[![Build](https://img.shields.io/travis/com/gh-conf/upstream-core.svg)](https://travis-ci.com/gh-conf/upstream-core/)

Configures upstream for a forked repository at the given directory path

## Install

```
npm install @gh-conf/upstream-core
```

## Usage

```js
const upstream = require('@gh-conf/upstream-core');

await upstream('/home/arshad/upstream-core');

await upstream(process.cwd());
```

## Contributing

Interested in contributing to this project?
You can log any issues or suggestion related to this library [here](https://github.com/gh-conf/upstream-core/issues/new).

Read our contributing [guide](CONTRIBUTING.md) to get started with contributing to the codebase.

## Contributors

Thank you to all the contributors who have helped us in making this project better 🙌

<a href="https://github.com/arshadkazmi42"><img src="https://github.com/arshadkazmi42.png" width="30" /></a>

## Related

- [upstreamit](https://github.com/gh-conf/upstreamit)
npm package: @gh-conf/upstreamit
Description: Add upstream url for a forked repository
Author: Arshad Kazmi
Latest version: 1.2.2

# upstreamit

[![Build](https://img.shields.io/travis/com/gh-conf/upstreamit.svg)](https://travis-ci.com/gh-conf/upstreamit/)
[![Github Repo Size](https://img.shields.io/github/repo-size/gh-conf/upstreamit.svg)](https://github.com/gh-conf/upstreamit)
[![LICENSE](https://img.shields.io/npm/l/@gh-conf/upstreamit.svg)](https://github.com/gh-conf/upstreamit/blob/master/LICENSE)
[![NPM Downloads](https://img.shields.io/npm/dt/@gh-conf/upstreamit.svg)](https://www.npmjs.com/package/@gh-conf/upstreamit)
[![NPM Version](https://img.shields.io/npm/v/@gh-conf/upstreamit.svg)](https://www.npmjs.com/package/@gh-conf/upstreamit)
[![Contributors](https://img.shields.io/github/contributors/gh-conf/upstreamit.svg)](https://github.com/gh-conf/upstreamit/graphs/contributors)
[![Commit](https://img.shields.io/github/last-commit/gh-conf/upstreamit.svg)](https://github.com/gh-conf/upstreamit/commits/master)

CLI tool to configure upstream from parent repository. This works only for forked repositories.

## Install

```
npm install @gh-conf/upstreamit -g
```

## Usage

```js
$ upstreamit

// ✔ Upstream Configured!!!
// ✖ Not a forked repository!!!
```

## Contributing

Interested in contributing to this project?
You can log any issues or suggestion related to this library [here](https://github.com/gh-conf/upstreamit/issues/new).

Read our contributing [guide](CONTRIBUTING.md) to get started with contributing to the codebase.

## Contributors

Thank you to all the contributors who have helped us in making this project better 🙌

<a href="https://github.com/arshadkazmi42"><img src="https://github.com/arshadkazmi42.png" width="30" /></a>
<a href="https://github.com/nileshkumar"><img src="https://github.com/nileshkumar.png" width="30" /></a>
<a href="https://github.com/kozlovvski"><img src="https://github.com/kozlovvski.png" width="30" /></a>