diff --git a/readme.md b/readme.md index b2cdc22..29e837b 100644 --- a/readme.md +++ b/readme.md @@ -1,45 +1,15 @@ -# del [![Build Status](https://travis-ci.org/sindresorhus/del.svg?branch=master)](https://travis-ci.org/sindresorhus/del) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo) +# del [![Build Status](https://travis-ci.com/sindresorhus/del.svg?branch=master)](https://travis-ci.com/github/sindresorhus/del) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo) > Delete files and directories using [globs](https://github.com/sindresorhus/globby#globbing-patterns) Similar to [rimraf](https://github.com/isaacs/rimraf), but with a Promise API and support for multiple files and globbing. It also protects you against deleting the current working directory and above. -
- ---- - -
-

-

- - My open source work is supported by the community - -

- Special thanks to: -
-
- - Botpress - -
- Botpress is an open-source conversational assistant creation platform. -
- They welcome contributions from anyone, whether you're into machine learning,
want to get started in open-source, or just have an improvement idea.
-
-

-
- ---- - -
- ## Install ``` $ npm install del ``` - ## Usage ```js @@ -55,7 +25,6 @@ const del = require('del'); })(); ``` - ## Beware The glob pattern `**` matches all children and *the parent*. @@ -80,7 +49,6 @@ del.sync(['public/*/']); Suggestions on how to improve this welcome! - ## API Note that glob patterns can only contain forward-slashes, not backward-slashes. Windows file paths can use backward-slashes as long as the path does not contain any glob-like characters, otherwise use `path.posix.join()` instead of `path.join()`. @@ -110,14 +78,14 @@ You can specify any of the [`globby` options](https://github.com/sindresorhus/gl ##### force -Type: `boolean`
+Type: `boolean`\ Default: `false` Allow deleting the current working directory and outside. ##### dryRun -Type: `boolean`
+Type: `boolean`\ Default: `false` See what would be deleted. @@ -134,25 +102,22 @@ const del = require('del'); ##### concurrency -Type: `number`
-Default: `Infinity`
+Type: `number`\ +Default: `Infinity`\ Minimum: `1` Concurrency limit. - ## CLI See [del-cli](https://github.com/sindresorhus/del-cli) for a CLI for this module and [trash-cli](https://github.com/sindresorhus/trash-cli) for a safe version that is suitable for running by hand. - ## del for enterprise Available as part of the Tidelift Subscription. The maintainers of del and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-del?utm_source=npm-del&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) - ## Related - [make-dir](https://github.com/sindresorhus/make-dir) - Make a directory and its parents if needed