An open API service indexing awesome lists of open source software.

https://github.com/saqqdy/js2git

js2git is a modern, high performance git client for node.js
https://github.com/saqqdy/js2git

Last synced: 7 months ago
JSON representation

js2git is a modern, high performance git client for node.js

Awesome Lists containing this project

README

          

# js2git

js2git is a modern, high performance git client for node.js

[![NPM version][npm-image]][npm-url]
[![Codacy Badge][codacy-image]][codacy-url]
[![tree shaking][tree-shaking-image]][tree-shaking-url]
![typescript][typescript-url]
[![Test coverage][codecov-image]][codecov-url]
[![npm download][download-image]][download-url]
[![License][license-image]][license-url]

[![Sonar][sonar-image]][sonar-url]

### **[Documentation](https://www.saqqdy.com/js2git)** • **[Change Log](./CHANGELOG.md)**

- [js2git](#js2git)
- [Installation](#installation)
- [Usage](#usage)
- [Nodejs require](#nodejs-require)
- [ES6 module](#es6-module)
- [API Reference](#api-reference)
- [js2git](#js2git)
- [Support & Issues](#support--issues)
- [License](#license)

## Installing

```bash
# use pnpm
$ pnpm install js2git

# use npm
$ npm install js2git --save
```

## Usage

### 1. Nodejs require

```js
const { config } = require('js2git')

//
```

### 2. ES6 module

```js
import { config } from 'js2git'

//
```

## API Reference

### js2git

xxxxxxx

- Since: `1.0.0`

- Arguments:

| Parameters | Description | Type | Optional | Required | Default |
| ---------- | ----------- | -------- | -------- | -------- | ------- |
| xxx | xx | `string` | - | true | - |

- Returns: ``

- Example:

```ts
//
```

- Types:

```ts
//
```

## Support & Issues

Please open an issue [here](https://github.com/saqqdy/js2git/issues).

## License

[MIT](LICENSE)

[npm-image]: https://img.shields.io/npm/v/js2git.svg?style=flat-square
[npm-url]: https://npmjs.org/package/js2git
[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696
[codacy-url]: https://www.codacy.com/gh/saqqdy/js2git/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/js2git&utm_campaign=Badge_Grade
[tree-shaking-image]: https://badgen.net/bundlephobia/tree-shaking/js2git
[tree-shaking-url]: https://bundlephobia.com/package/js2git
[typescript-url]: https://badgen.net/badge/icon/typescript?icon=typescript&label
[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/js2git.svg?style=flat-square
[codecov-url]: https://codecov.io/github/saqqdy/js2git?branch=master
[download-image]: https://img.shields.io/npm/dm/js2git.svg?style=flat-square
[download-url]: https://npmjs.org/package/js2git
[license-image]: https://img.shields.io/badge/License-MIT-blue.svg
[license-url]: LICENSE
[sonar-image]: https://sonarcloud.io/api/project_badges/quality_gate?project=saqqdy_js2git
[sonar-url]: https://sonarcloud.io/dashboard?id=saqqdy_js2git