Skip to content

Commit

Permalink
generate readme, lint
Browse files Browse the repository at this point in the history
  • Loading branch information
jonschlinkert committed Apr 5, 2016
1 parent 4017136 commit 4397255
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 25 deletions.
52 changes: 34 additions & 18 deletions README.md
@@ -1,13 +1,13 @@
# is-posix-bracket [![NPM version](https://badge.fury.io/js/is-posix-bracket.svg)](http://badge.fury.io/js/is-posix-bracket)
# is-posix-bracket [![NPM version](https://img.shields.io/npm/v/is-posix-bracket.svg?style=flat)](https://www.npmjs.com/package/is-posix-bracket) [![NPM downloads](https://img.shields.io/npm/dm/is-posix-bracket.svg?style=flat)](https://npmjs.org/package/is-posix-bracket) [![Build Status](https://img.shields.io/travis/jonschlinkert/is-posix-bracket.svg?style=flat)](https://travis-ci.org/jonschlinkert/is-posix-bracket)

> Returns true if the given string is a POSIX bracket expression (POSIX character class).
## Install

Install with [npm](https://www.npmjs.com/)
Install with [npm](https://www.npmjs.com/):

```sh
$ npm i is-posix-bracket --save
$ npm install is-posix-bracket --save
```

## Usage
Expand Down Expand Up @@ -37,36 +37,52 @@ isPosixBracket('[abc[:punct:][0-9]');

## Related projects

* [braces](https://github.com/jonschlinkert/braces): Fastest brace expansion for node.js, with the most complete support for the Bash 4.3 braces… [more](https://github.com/jonschlinkert/braces)
* [expand-brackets](https://github.com/jonschlinkert/expand-brackets): Expand POSIX bracket expressions (character classes) in glob patterns.
* [is-glob](https://github.com/jonschlinkert/is-glob): Returns `true` if the given string looks like a glob pattern.
* [is-extglob](https://github.com/jonschlinkert/is-extglob): Returns true if a string has an extglob.
* [micromatch](https://github.com/jonschlinkert/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. Just… [more](https://github.com/jonschlinkert/micromatch)
You might also be interested in these projects:

## Running tests
* [braces](https://www.npmjs.com/package/braces): Fastest brace expansion for node.js, with the most complete support for the Bash 4.3 braces… [more](https://www.npmjs.com/package/braces) | [homepage](https://github.com/jonschlinkert/braces)
* [expand-brackets](https://www.npmjs.com/package/expand-brackets): Expand POSIX bracket expressions (character classes) in glob patterns. | [homepage](https://github.com/jonschlinkert/expand-brackets)
* [is-extglob](https://www.npmjs.com/package/is-extglob): Returns true if a string has an extglob. | [homepage](https://github.com/jonschlinkert/is-extglob)
* [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern.… [more](https://www.npmjs.com/package/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob)
* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. Just… [more](https://www.npmjs.com/package/micromatch) | [homepage](https://github.com/jonschlinkert/micromatch)

Install dev dependencies:
## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/is-posix-bracket/issues/new).

## Building docs

Generate readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm i -d && npm test
$ npm install verb && npm run docs
```

## Contributing
Or, if [verb](https://github.com/verbose/verb) is installed globally:

```sh
$ verb
```

## Running tests

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/is-posix-bracket/issues/new)
Install dev dependencies:

```sh
$ npm install -d && npm test
```

## Author

**Jon Schlinkert**

+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

## License

Copyright © 2015 Jon Schlinkert
Released under the MIT license.
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/jonschlinkert/is-posix-bracket/blob/master/LICENSE).

***

_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on August 01, 2015._
_This file was generated by [verb](https://github.com/verbose/verb), v, on April 05, 2016._
7 changes: 0 additions & 7 deletions test.js
@@ -1,10 +1,3 @@
/*!
* is-posix-bracket <https://github.com/jonschlinkert/is-posix-bracket>
*
* Copyright (c) 2015 .
* Licensed under the MIT license.
*/

'use strict';

require('mocha');
Expand Down

0 comments on commit 4397255

Please sign in to comment.