Skip to content

Commit

Permalink
Remove gulp version from description, update examples to use const, m…
Browse files Browse the repository at this point in the history
…inor formatting
  • Loading branch information
tommcc authored and lazd committed Jan 15, 2021
1 parent fe1e519 commit 015a90d
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# gulp-replace [![NPM version][npm-image]][npm-url] [![Build status][travis-image]][travis-url]
> A string replace plugin for gulp 3
> A string replace plugin for gulp
## Usage

Expand All @@ -13,7 +13,7 @@ Then, add it to your `gulpfile.js`:

### Simple string replace
```javascript
var replace = require('gulp-replace');
const replace = require('gulp-replace');

gulp.task('templates', function(){
gulp.src(['file.txt'])
Expand All @@ -24,7 +24,7 @@ gulp.task('templates', function(){

### Simple regex replace
```javascript
var replace = require('gulp-replace');
const replace = require('gulp-replace');

gulp.task('templates', function(){
gulp.src(['file.txt'])
Expand All @@ -36,7 +36,7 @@ gulp.task('templates', function(){

### String replace with function callback
```javascript
var replace = require('gulp-replace');
const replace = require('gulp-replace');

gulp.task('templates', function(){
gulp.src(['file.txt'])
Expand All @@ -50,7 +50,7 @@ gulp.task('templates', function(){

### Regex replace with function callback
```javascript
var replace = require('gulp-replace');
const replace = require('gulp-replace');

gulp.task('templates', function(){
gulp.src(['file.txt'])
Expand All @@ -66,7 +66,7 @@ gulp.task('templates', function(){

### Function callback with file object
```javascript
var replace = require('gulp-replace');
const replace = require('gulp-replace');

gulp.task('templates', function(){
gulp.src(['file.txt'])
Expand All @@ -83,7 +83,7 @@ gulp.task('templates', function(){

## API

gulp-replace can be called with a string or regex.
`gulp-replace` can be called with a string or regex.

### replace(string, replacement[, options])

Expand Down Expand Up @@ -124,7 +124,7 @@ Type: `Object`
Type: `boolean`
Default: `true`

Skip binary files. This option is true by default. If you want to replace content in binary files, you must explicitly set it to false
Skip binary files. This option is `true` by default. If you want to replace content in binary files, you must explicitly set it to `false`.


[MDN documentation for RegExp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp
Expand Down

0 comments on commit 015a90d

Please sign in to comment.