Skip to content

Commit b3d6ba9

Browse files
committed
README: Describe project status; simplify build/test instructions
1 parent 18bf042 commit b3d6ba9

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
# jQuery.simulate()
22

3-
How to build and test jQuery Simulate
4-
----------------------------------
3+
Simulate events to help unit test user interactions.
54

6-
First, get a copy of the git repo by running:
5+
Project Status
6+
--------------
77

8-
```shell
9-
git clone git://github.com/jquery/jquery-simulate.git
10-
```
8+
jquery-simulate is in use by projects of the jQuery Foundation, but isn't under active development. Usually issues are addressed by members of the jQuery UI team when they're affected, while other pull requests linger and get stale. We hesitate to put more time into this project, since its future is unclear.
119

12-
Enter the directory and install the node dependencies:
10+
Specifically we're hoping for the WebDriver API to become a much better solution. We're currently experiementing with that, via [Intern](http://theintern.io/) on [PEP](https://github.com/jquery/pep)).
1311

14-
```shell
15-
cd jquery-simulate && npm install
16-
```
12+
That said, this project is stable and should work fine. Just keep the above in mind before using it.
1713

18-
Make sure you have `grunt` installed by testing:
14+
How to build
15+
------------
1916

20-
```shell
21-
grunt -version
22-
```
17+
If you don't yet have grunt installed:
2318

24-
If not, run:
19+
```sh
20+
npm install -g grunt-cli
21+
```
2522

26-
```shell
27-
npm install -g grunt
23+
Then:
24+
```sh
25+
npm install
26+
grunt
2827
```
2928

30-
To run tests locally, run `grunt`, and this will run the tests in PhantomJS.
29+
How to test
30+
-----------
3131

32-
You can also run the tests in a browser by navigating to the `test/` directory, but first run `grunt` to install submodules.
32+
Open the `test/index.html` in a browser.

0 commit comments

Comments
 (0)