https://github.com/fabiospampinato/autogit-command-readme-autocommit

A command for autocommitting changes to the readme.
https://github.com/fabiospampinato/autogit-command-readme-autocommit

autocommit autogit command readme

Last synced: about 1 month ago
JSON representation

A command for autocommitting changes to the readme.

• Host: GitHub
• URL: https://github.com/fabiospampinato/autogit-command-readme-autocommit
• Owner: fabiospampinato
• License: mit
• Archived: true
• Created: 2018-10-08T03:47:46.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-01-24T20:28:59.000Z (almost 5 years ago)
• Last Synced: 2024-05-01T12:39:08.201Z (8 months ago)
• Topics: autocommit, autogit, command, readme
• Language: TypeScript
• Size: 16.6 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Autogit Command - Readme Autocommit

A command for autocommitting changes to the readme.

## Install

```sh

npm install --save autogit-command-readme-autocommit

```

## Usage

#### Options

This command uses the following options object:

```js

{

  remote: 'origin', // The remote to push to

  branch: '' // The branch to push to, if not set the current branch will be used

  message: 'Readme: update', // Commit message

  paths: ['README.md', 'Readme.md', 'readme.md', 'README', 'Readme', 'readme'] // When these paths change a commit will be made

}

```

#### Configuration

Add this command to your configuration:

```js

const readmeAutocommit = require ( 'autogit-command-readme-autocommit' );

module.exports = {

  commands: {

    'readme-autocommit': readmeAutocommit 

  }

}

```

#### CLI

Call it from the CLI with:

```sh

autogit readme-autocommit

```

## License

MIT © Fabio Spampinato