Skip to content

Commit d62ec37

Browse files
jonschlinkertjonschlinkert
committed
run verb to generate readme documentation
1 parent b699258 commit d62ec37

File tree

1 file changed

+32
-40
lines changed

1 file changed

+32
-40
lines changed

‎README.md

+32-40
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
# bash-glob [![NPM version](https://img.shields.io/npm/v/bash-glob.svg?style=flat)](https://www.npmjs.com/package/bash-glob) [![NPM monthly downloads](https://img.shields.io/npm/dm/bash-glob.svg?style=flat)](https://npmjs.org/package/bash-glob) [![NPM total downloads](https://img.shields.io/npm/dt/bash-glob.svg?style=flat)](https://npmjs.org/package/bash-glob) [![Linux Build Status](https://img.shields.io/travis/micromatch/bash-glob.svg?style=flat&label=Travis)](https://travis-ci.org/micromatch/bash-glob)
1+
# bash-glob [![NPM version](https://img.shields.io/npm/v/bash-glob.svg?style=flat)](https://www.npmjs.com/package/bash-glob) [![NPM monthly downloads](https://img.shields.io/npm/dm/bash-glob.svg?style=flat)](https://npmjs.org/package/bash-glob) [![NPM total downloads](https://img.shields.io/npm/dt/bash-glob.svg?style=flat)](https://npmjs.org/package/bash-glob) [![Linux Build Status](https://img.shields.io/travis/micromatch/bash-glob.svg?style=flat&label=Travis)](https://travis-ci.org/micromatch/bash-glob)
22

33
> Bash-powered globbing for node.js
44
5+
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
6+
57
## Install
68

79
Install with [npm](https://www.npmjs.com/):
@@ -10,12 +12,6 @@ Install with [npm](https://www.npmjs.com/):
1012
$ npm install --save bash-glob
1113
```
1214

13-
Install with [yarn](https://yarnpkg.com):
14-
15-
```sh
16-
$ yarn add bash-glob
17-
```
18-
1915
**Install bash 4.3 or later**
2016

2117
I recommend using [homebrew](https://github.com/Homebrew/homebrew-core) to install/upgrade bash:
@@ -45,10 +41,7 @@ glob(pattern[, options]);
4541

4642
## API
4743

48-
<details>
49-
<summary><strong>glob</strong></summary>
50-
51-
### [glob](index.js#L32)
44+
### [glob](index.js#L30)
5245

5346
Asynchronously returns an array of files that match the given pattern or patterns.
5447

@@ -68,12 +61,7 @@ glob('*.js', function(err, files) {
6861
});
6962
```
7063

71-
</details>
72-
73-
<details>
74-
<summary><strong>.each</strong></summary>
75-
76-
### [.each](index.js#L100)
64+
### [.each](index.js#L98)
7765

7866
Asynchronously glob an array of files that match any of the given `patterns`.
7967

@@ -93,12 +81,7 @@ glob.each(['*.js', '*.md'], {dot: true}, function(err, files) {
9381
});
9482
```
9583

96-
</details>
97-
98-
<details>
99-
<summary><strong>.sync</strong></summary>
100-
101-
### [.sync](index.js#L156)
84+
### [.sync](index.js#L154)
10285

10386
Returns an array of files that match the given patterns or patterns.
10487

@@ -116,8 +99,6 @@ console.log(glob.sync('*.js', {cwd: 'foo'}));
11699
console.log(glob.sync(['*.js'], {cwd: 'bar'}));
117100
```
118101

119-
</details>
120-
121102
## Options
122103

123104
The following options may be used with the main `glob` function or any other method:
@@ -131,20 +112,28 @@ The following options may be used with the main `glob` function or any other met
131112

132113
## About
133114

134-
### Related projects
135-
136-
* [bash-match](https://www.npmjs.com/package/bash-match): Match strings using bash. Does not work on windows, and does not read from the… [more](https://github.com/jonschlinkert/bash-match) | [homepage](https://github.com/jonschlinkert/bash-match "Match strings using bash. Does not work on windows, and does not read from the file system. This library requires that Bash 4.3 or higher is installed and is mostly used for checking parity in unit tests.")
137-
* [braces](https://www.npmjs.com/package/braces): Fast, comprehensive, bash-like brace expansion implemented in JavaScript. Complete support for the Bash 4.3 braces… [more](https://github.com/micromatch/braces) | [homepage](https://github.com/micromatch/braces "Fast, comprehensive, bash-like brace expansion implemented in JavaScript. Complete support for the Bash 4.3 braces specification, without sacrificing speed.")
138-
* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/jonschlinkert/micromatch "Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.")
139-
* [nanomatch](https://www.npmjs.com/package/nanomatch): Fast, minimal glob matcher for node.js. Similar to micromatch, minimatch and multimatch, but complete Bash… [more](https://github.com/jonschlinkert/nanomatch) | [homepage](https://github.com/jonschlinkert/nanomatch "Fast, minimal glob matcher for node.js. Similar to micromatch, minimatch and multimatch, but complete Bash 4.3 wildcard support only (no support for exglobs, posix brackets or braces)")
140-
141-
### Contributing
115+
<details>
116+
<summary><strong>Contributing</strong></summary>
142117

143118
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
144119

145120
Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.
146121

147-
### Building docs
122+
</details>
123+
124+
<details>
125+
<summary><strong>Running Tests</strong></summary>
126+
127+
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
128+
129+
```sh
130+
$ npm install && npm test
131+
```
132+
133+
</details>
134+
135+
<details>
136+
<summary><strong>Building docs</strong></summary>
148137

149138
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
150139

@@ -154,13 +143,16 @@ To generate the readme, run the following command:
154143
$ npm install -g verbose/verb#dev verb-generate-readme && verb
155144
```
156145

157-
### Running tests
146+
</details>
158147

159-
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
148+
### Related projects
160149

161-
```sh
162-
$ npm install && npm test
163-
```
150+
You might also be interested in these projects:
151+
152+
* [bash-match](https://www.npmjs.com/package/bash-match): Match strings using bash. Does not work on windows, and does not read from the… [more](https://github.com/micromatch/bash-match) | [homepage](https://github.com/micromatch/bash-match "Match strings using bash. Does not work on windows, and does not read from the file system. This library requires that Bash 4.3 or higher is installed and is mostly used for checking parity in unit tests.")
153+
* [braces](https://www.npmjs.com/package/braces): Bash-like brace expansion, implemented in JavaScript. Safer than other brace expansion libs, with complete support… [more](https://github.com/micromatch/braces) | [homepage](https://github.com/micromatch/braces "Bash-like brace expansion, implemented in JavaScript. Safer than other brace expansion libs, with complete support for the Bash 4.3 braces specification, without sacrificing speed.")
154+
* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/micromatch/micromatch "Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.")
155+
* [nanomatch](https://www.npmjs.com/package/nanomatch): Fast, minimal glob matcher for node.js. Similar to micromatch, minimatch and multimatch, but complete Bash… [more](https://github.com/micromatch/nanomatch) | [homepage](https://github.com/micromatch/nanomatch "Fast, minimal glob matcher for node.js. Similar to micromatch, minimatch and multimatch, but complete Bash 4.3 wildcard support only (no support for exglobs, posix brackets or braces)")
164156

165157
### Author
166158

@@ -176,4 +168,4 @@ Released under the [MIT License](LICENSE).
176168

177169
***
178170

179-
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on April 27, 2017._
171+
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on October 22, 2017._

0 commit comments

Comments
 (0)