https://github.com/gh-conf/upstream-core

Upstream core engine
https://github.com/gh-conf/upstream-core

config core engine fork gh-conf github upstream upstreamit

Last synced: 6 months ago
JSON representation

Upstream core engine

• Host: GitHub
• URL: https://github.com/gh-conf/upstream-core
• Owner: gh-conf
• License: mit
• Created: 2019-10-24T15:53:39.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-07-12T12:33:27.000Z (almost 3 years ago)
• Last Synced: 2024-11-29T03:38:17.206Z (6 months ago)
• Topics: config, core, engine, fork, gh-conf, github, upstream, upstreamit
• Language: JavaScript
• Size: 93.8 KB
• Stars: 1
• Watchers: 2
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# upstream-core

![Build](https://github.com/gh-conf/upstream-core/actions/workflows/nodejs.yml/badge.svg)

[![NPM Version](https://img.shields.io/npm/v/@gh-conf/upstream-core.svg)](https://www.npmjs.com/package/@gh-conf/upstream-core)

[![NPM Downloads](https://img.shields.io/npm/dt/@gh-conf/upstream-core.svg)](https://www.npmjs.com/package/@gh-conf/upstream-core)

[![Github Repo Size](https://img.shields.io/github/repo-size/gh-conf/upstream-core.svg)](https://github.com/gh-conf/upstream-core)

[![LICENSE](https://img.shields.io/npm/l/@gh-conf/upstream-core.svg)](https://github.com/gh-conf/upstream-core/blob/master/LICENSE)

[![Contributors](https://img.shields.io/github/contributors/gh-conf/upstream-core.svg)](https://github.com/gh-conf/upstream-core/graphs/contributors)

[![Commit](https://img.shields.io/github/last-commit/gh-conf/upstream-core.svg)](https://github.com/gh-conf/upstream-core/commits/master)

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.

## Related

- [upstreamit](https://github.com/gh-conf/upstreamit)