Skip to content

Commit d472055

Browse files
committed
Readme: Improve instructions
Changes: * Drop the dead Jenkins link; we use GitHub Actions now * Update supported jQuery versions * Simplify Git clone instructions to refer to GitHub docs * Remove references to concrete versions in favor of linking to https://releases.jquery.com/color/
1 parent aefc682 commit d472055

File tree

1 file changed

+7
-28
lines changed

1 file changed

+7
-28
lines changed

README.md

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
[![Build Status](http://jenkins.jquery.com/job/jQuery%20Color/badge/icon)](http://jenkins.jquery.com/job/jQuery%20Color/)
2-
31
# jQuery Color
42

5-
Supported jQuery versions: 1.8+
3+
Supported jQuery versions: 1.12+ (only the latest version within each jQuery major is tested)
64

75
## Browser Support
86

@@ -17,44 +15,24 @@ Other browsers may also work correctly with this plugin but support is not guara
1715
Information on browser support of jQuery Color 2.x can be found in the [Browser Support section](https://github.com/jquery/jquery-color/blob/2.x-stable/README.md#browser-support) in its README.
1816

1917
## Using jQuery Color in Production
20-
We release jQuery Color by itself, or in a bundle. The extended names can be included as a jQuery Color plugin, or you can download the version of jQuery Color that includes the names. Choose your build from the following list:
21-
22-
**Current version: 2.1.2**
2318

24-
* jQuery Color [Compressed](http://code.jquery.com/color/jquery.color-2.1.2.min.js) [Uncompressed](http://code.jquery.com/color/jquery.color-2.1.2.js)
25-
* jQuery Color Extended Names [Compressed](http://code.jquery.com/color/jquery.color.svg-names-2.1.2.min.js) [Uncompressed](http://code.jquery.com/color/jquery.color.svg-names-2.1.2.js)
26-
* jQuery Color & Extended Names(previous two combined) [Compressed](http://code.jquery.com/color/jquery.color.plus-names-2.1.2.min.js) [Uncompressed](http://code.jquery.com/color/jquery.color.plus-names-2.1.2.js)
19+
We release jQuery Color by itself, or in a bundle. The extended names can be included as a jQuery Color plugin, or you can download the version of jQuery Color that includes the names. Choose your version & build from the list at https://releases.jquery.com/color/.
2720

2821
## How to build and test jQuery Color
2922

30-
First, get a copy of the git repo by running:
31-
32-
```shell
33-
git clone git://github.com/jquery/jquery-color.git
34-
```
23+
First, [clone the jQuery Color git repo](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository).
3524

3625
Enter the directory and install the node dependencies:
3726

3827
```shell
3928
cd jquery-color && npm install
4029
```
4130

42-
Make sure you have `grunt` installed by testing:
43-
44-
```shell
45-
grunt -version
31+
To build and test jQuery Color, run:
4632
```
47-
48-
If not, run:
49-
50-
```shell
51-
npm install -g grunt
33+
npm test
5234
```
5335

54-
To run tests locally, run `grunt`, and this will run the tests in PhantomJS.
55-
56-
You can also run the tests in a browser by navigating to the `test/` directory.
57-
5836
## Animated colors
5937

6038
This plugin installs a [`cssHook`](https://api.jquery.com/jQuery.cssHooks/) which allows jQuery's [`.animate()`](https://api.jquery.com/animate) to animate between two colors.
@@ -68,6 +46,7 @@ This plugin installs a [`cssHook`](https://api.jquery.com/jQuery.cssHooks/) whic
6846
<!DOCTYPE html>
6947
<html>
7048
<head>
49+
<title>jQuery Color demo</title>
7150
<style>
7251
div {
7352
background-color: #bada55;
@@ -215,7 +194,7 @@ If a color is created using any of the HSLA functions or parsers, it will keep t
215194

216195
## Extensibility
217196

218-
It is possible for you to add your own functions to the color object. For instance, this function will tell you if its better to use black or white on a given background color.
197+
It is possible for you to add your own functions to the color object. For instance, this function will tell you if it's better to use black or white on a given background color.
219198

220199

221200
```javascript

0 commit comments

Comments
 (0)