Skip to content

Commit a6496e2

Browse files
committed
run verb to generate readme
1 parent fe78d6f commit a6496e2

File tree

1 file changed

+34
-28
lines changed

1 file changed

+34
-28
lines changed

README.md

+34-28
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,16 @@
1-
# copy [![NPM version](https://img.shields.io/npm/v/copy.svg?style=flat)](https://www.npmjs.com/package/copy) [![NPM downloads](https://img.shields.io/npm/dm/copy.svg?style=flat)](https://npmjs.org/package/copy) [![Build Status](https://img.shields.io/travis/jonschlinkert/copy.svg?style=flat)](https://travis-ci.org/jonschlinkert/copy)
1+
# copy [![NPM version](https://img.shields.io/npm/v/copy.svg?style=flat)](https://www.npmjs.com/package/copy) [![NPM monthly downloads](https://img.shields.io/npm/dm/copy.svg?style=flat)](https://npmjs.org/package/copy) [![NPM total downloads](https://img.shields.io/npm/dt/copy.svg?style=flat)](https://npmjs.org/package/copy) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/copy.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/copy) [![Windows Build Status](https://img.shields.io/appveyor/ci/jonschlinkert/copy.svg?style=flat&label=AppVeyor)](https://ci.appveyor.com/project/jonschlinkert/copy)
22

3-
Copy files or directories using globs.
3+
> Copy files or directories using globs.
44
5-
## TOC
5+
## Table of Contents
66

77
- [Install](#install)
88
- [Usage](#usage)
99
- [Examples](#examples)
1010
- [API](#api)
1111
- [CLI](#cli)
1212
- [History](#history)
13-
- [Related projects](#related-projects)
14-
- [Contributing](#contributing)
15-
- [Building docs](#building-docs)
16-
- [Running tests](#running-tests)
17-
- [Author](#author)
18-
- [License](#license)
13+
- [About](#about)
1914

2015
_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
2116

@@ -103,7 +98,7 @@ copy.each(['foo.txt', 'bar.txt', 'baz.txt'], 'dist', function(err, files) {
10398
});
10499
```
105100

106-
### [.copy.one](index.js#L122)
101+
### [.copy.one](index.js#L132)
107102

108103
Copy a single `file` to the given `dest` directory, using the specified options and callback function.
109104

@@ -158,51 +153,62 @@ $ copy *.js foo
158153

159154
* The API was changed in 0.2.0. please review the [API documentation](#api)
160155

161-
## Related projects
156+
## About
162157

163-
You might also be interested in these projects:
158+
### Related projects
164159

165160
* [expand-config](https://www.npmjs.com/package/expand-config): Expand tasks, targets and files in a declarative configuration. | [homepage](https://github.com/jonschlinkert/expand-config "Expand tasks, targets and files in a declarative configuration.")
166161
* [expand-files](https://www.npmjs.com/package/expand-files): Expand glob patterns in a declarative configuration into src-dest mappings. | [homepage](https://github.com/jonschlinkert/expand-files "Expand glob patterns in a declarative configuration into src-dest mappings.")
167162
* [expand-target](https://www.npmjs.com/package/expand-target): Expand target definitions in a declarative configuration. | [homepage](https://github.com/jonschlinkert/expand-target "Expand target definitions in a declarative configuration.")
168163
* [expand-task](https://www.npmjs.com/package/expand-task): Expand and normalize task definitions in a declarative configuration. | [homepage](https://github.com/jonschlinkert/expand-task "Expand and normalize task definitions in a declarative configuration.")
169164
* [export-files](https://www.npmjs.com/package/export-files): node.js utility for exporting a directory of files as modules. | [homepage](https://github.com/jonschlinkert/export-files "node.js utility for exporting a directory of files as modules.")
170-
* [write](https://www.npmjs.com/package/write): Write files to disk, creating intermediate directories if they don't exist. | [homepage](https://github.com/jonschlinkert/write "Write files to disk, creating intermediate directories if they don't exist.")
165+
* [write](https://www.npmjs.com/package/write): Write data to a file, replacing the file if it already exists and creating any… [more](https://github.com/jonschlinkert/write) | [homepage](https://github.com/jonschlinkert/write "Write data to a file, replacing the file if it already exists and creating any intermediate directories if they don't already exist. Thin wrapper around node's native fs methods.")
171166

172-
## Contributing
167+
### Contributing
173168

174-
This document was generated by [verb-readme-generator](https://github.com/verbose/verb-readme-generator) (a [verb](https://github.com/verbose/verb) generator), please don't edit directly. Any changes to the readme must be made in [.verb.md](.verb.md). See [Building Docs](#building-docs).
169+
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
175170

176-
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). Or visit the [verb-readme-generator](https://github.com/verbose/verb-readme-generator) project to submit bug reports or pull requests for the readme layout template.
171+
### Contributors
177172

178-
## Building docs
173+
| **Commits** | **Contributor** |
174+
| --- | --- |
175+
| 61 | [jonschlinkert](https://github.com/jonschlinkert) |
176+
| 2 | [joakimbeng](https://github.com/joakimbeng) |
177+
| 1 | [bleathem](https://github.com/bleathem) |
178+
| 1 | [doowb](https://github.com/doowb) |
179+
| 1 | [gsantiago](https://github.com/gsantiago) |
180+
| 1 | [SoulRIver2015](https://github.com/SoulRIver2015) |
179181

180-
Generate readme and API documentation with [verb](https://github.com/verbose/verb):
182+
### Building docs
183+
184+
_(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.)_
185+
186+
To generate the readme, run the following command:
181187

182188
```sh
183-
$ npm install -g verb verb-readme-generator && verb
189+
$ npm install -g verbose/verb#dev verb-generate-readme && verb
184190
```
185191

186-
## Running tests
192+
### Running tests
187193

188-
Install dev dependencies:
194+
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:
189195

190196
```sh
191-
$ npm install -d && npm test
197+
$ npm install && npm test
192198
```
193199

194-
## Author
200+
### Author
195201

196202
**Jon Schlinkert**
197203

198204
* [github/jonschlinkert](https://github.com/jonschlinkert)
199-
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
205+
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
200206

201-
## License
207+
### License
202208

203-
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
204-
Released under the [MIT license](https://github.com/jonschlinkert/copy/blob/master/LICENSE).
209+
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
210+
Released under the [MIT License](LICENSE).
205211

206212
***
207213

208-
_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on June 19, 2016._
214+
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on September 01, 2017._

0 commit comments

Comments
 (0)