# @d2k/commit

> Easy commit and push functionality for Github based on Octokat

Latest version **0.0.1** (published 2018-09-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install @d2k/commit
pnpm add @d2k/commit
yarn add @d2k/commit
bun add @d2k/commit
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2018-09-12 |
| First published | 2018-09-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Dominik Biedebach |
| Maintainers | d2k |
| Keywords | commit, github, nodejs, post, octokat |

## Links

- npm: https://www.npmjs.com/package/@d2k/commit
- Repository: https://github.com/bdbch/commit
- Homepage: https://github.com/bdbch/commit#readme
- Issues: https://github.com/bdbch/commit/issues
- npm.io page: https://npm.io/package/@d2k/commit

## Recent versions

- 0.0.1 (latest) — 2018-09-12

## README

# Commit

> Octokat Extension for easy commiting

## Installation

```
npm i octokat @d2k/commit --save
```

or

```
yarn add octokat @d2k/commit
```

## Usage

```js
// Require packages
const Octokat = require('octokat')
const Commit = require('commit')

// Create new Instance
const OctokatInstance = new Octokat({ token: YOUR_API_TOKEN })

// Create Commit Object
const newCommit = new Commit({
  username: 'your_github_username',
  repo: 'your_github_repository',
  branch: 'target_branch',
  changes: { "file-one.html": "<h1>Hello</h1>", "file-two.html": "<h2>World</h2>" },
  message: "My first Commit"
})

// Submit Commit
newCommit.commit()
  .then(response => console.log(response))
  .catch(err => console.log(err))
```

---
_Source: https://npm.io/package/@d2k/commit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._