Skip to content

Commit 76eb4d6

Browse files
phatedphated
committed
Docs: Add installation instructions & update badges
1 parent fbc162f commit 76eb4d6

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

‎README.md‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<p align="center">The streaming build system</p>
66
</p>
77

8-
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![OpenCollective Backers][backer-badge]][backer-url] [![OpenCollective Sponsors][sponsor-badge]][sponsor-url] [![Gitter chat][gitter-image]][gitter-url]
8+
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![OpenCollective Backers][backer-badge]][backer-url] [![OpenCollective Sponsors][sponsor-badge]][sponsor-url] [![Gitter chat][gitter-image]][gitter-url]
99

1010

1111
## What is gulp?
@@ -15,12 +15,21 @@
1515
- **Strong Ecosystem** - Use npm modules to do anything you want + over 2000 curated plugins for streaming file transformations
1616
- **Simple** - By providing only a minimal API surface, gulp is easy to learn and simple to use
1717

18+
## Installation
19+
20+
There are a few ways to install:
21+
22+
* gulp v4.0.0 - `npm install gulp@next`
23+
* gulp v4.0.0-alpha.3 - `npm install gulpjs/gulp#4.0.0-alpha.3`
24+
* gulp v4.0.0-alpha.2 - `npm install gulpjs/gulp#4.0.0-alpha.2`
25+
* gulp v3.9.1 - `npm install gulp`
26+
1827
## Documentation
1928

2029
For a Getting started guide, API docs, recipes, making a plugin, etc. check out our docs!
2130

22-
- Need something reliable? Check out the [documentation for the current release](/docs/README.md)!
23-
- Want to help us test the latest and greatest? Check out the [documentation for the next release](https://github.com/gulpjs/gulp/tree/4.0)!
31+
- Check out the [documentation for v4.0.0](/docs/README.md)! __Note: these docs might be behind while we get everything updated.__
32+
- Using the older v3.9.1? Check out the [documentation at the v3.9.1 tag](https://github.com/gulpjs/gulp/tree/v3.9.1/docs)!
2433

2534
## Sample `gulpfile.js`
2635

@@ -259,16 +268,6 @@ function scripts() {
259268
}
260269
```
261270

262-
## Want to test the latest and greatest?
263-
264-
We're hard at work on our latest release, but we need your help testing it!
265-
266-
```sh
267-
npm install gulpjs/gulp#4.0
268-
```
269-
270-
There's a slew of major (wonderful) changes in 4.0, so make sure you check out the [docs on that branch](https://github.com/gulpjs/gulp/tree/4.0)!
271-
272271
## Want to contribute?
273272

274273
Anyone can help make this project better - check out our [Contributing guide](/CONTRIBUTING.md)!
@@ -290,7 +289,10 @@ Become a sponsor to get your logo on our README on Github.
290289
[npm-image]: https://img.shields.io/npm/v/gulp.svg
291290

292291
[travis-url]: https://travis-ci.org/gulpjs/gulp
293-
[travis-image]: https://img.shields.io/travis/gulpjs/gulp/master.svg
292+
[travis-image]: https://img.shields.io/travis/gulpjs/gulp.svg?label=travis-ci
293+
294+
[appveyor-url]: https://ci.appveyor.com/project/gulpjs/gulp
295+
[appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/gulp.svg?label=appveyor
294296

295297
[coveralls-url]: https://coveralls.io/r/gulpjs/gulp
296298
[coveralls-image]: https://img.shields.io/coveralls/gulpjs/gulp/master.svg

0 commit comments

Comments
 (0)