Skip to content

Commit

Permalink
chore(packageName): Rename to allow npm publish (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
michaeltaranto authored Oct 19, 2018
1 parent 0160ae5 commit 2f01036
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
[![Build Status](https://img.shields.io/travis/seek-oss/gitignore-ensure/master.svg?style=flat-square)](http://travis-ci.org/seek-oss/gitignore-ensure) [![npm](https://img.shields.io/npm/v/gitignore-ensure.svg?style=flat-square)](https://www.npmjs.com/package/gitignore-ensure) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/)
[![Build Status](https://img.shields.io/travis/seek-oss/ensure-gitignore/master.svg?style=flat-square)](http://travis-ci.org/seek-oss/ensure-gitignore) [![npm](https://img.shields.io/npm/v/ensure-gitignore.svg?style=flat-square)](https://www.npmjs.com/package/ensure-gitignore) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/)

# gitignore-ensure
# ensure-gitignore

Ensure the presence of patterns within a project's gitignore.

## Usage

```js
const gitignoreEnsure = require('gitignore-ensure');
const ensureGitignore = require('ensure-gitignore');

await gitignoreEnsure({
await ensureGitignore({
patterns: ['node_modules', 'output']
});
```
Expand All @@ -31,9 +31,9 @@ An array of patterns to ensure are present in the specified `.gitignore` file. A
Appended to each pattern that is being ensured to indicate what is programmatically being controlled.

```js
const gitignoreEnsure = require('gitignore-ensure');
const ensureGitignore = require('ensure-gitignore');

await gitignoreEnsure({
await ensureGitignore({
patterns: ['node_modules', 'output'],
comment: 'managed'
});
Expand All @@ -49,9 +49,9 @@ await gitignoreEnsure({
The file at the input path will not be updated, instead the intended output will be returned.

```js
const gitignoreEnsure = require('gitignore-ensure');
const ensureGitignore = require('ensure-gitignore');

const result = await gitignoreEnsure({
const result = await ensureGitignore({
patterns: ['node_modules', 'output'],
dryRun: true
});
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "gitignore-ensure",
"name": "ensure-gitignore",
"version": "0.0.0-development",
"description": "Ensure the presence of patterns within a project's gitignore",
"main": "index.js",
Expand All @@ -26,14 +26,14 @@
},
"repository": {
"type": "git",
"url": "https://github.com/seek-oss/gitignore-ensure.git"
"url": "https://github.com/seek-oss/ensure-gitignore.git"
},
"author": "SEEK",
"license": "MIT",
"bugs": {
"url": "https://github.com/seek-oss/gitignore-ensure/issues"
"url": "https://github.com/seek-oss/ensure-gitignore/issues"
},
"homepage": "https://github.com/seek-oss/gitignore-ensure#readme",
"homepage": "https://github.com/seek-oss/ensure-gitignore#readme",
"devDependencies": {
"@commitlint/cli": "^7.2.1",
"commitizen": "^3.0.2",
Expand Down

0 comments on commit 2f01036

Please sign in to comment.