UNPKG

4.1 kBMarkdownView Raw
1<a name="README">[<img src="https://rawgithub.com/jasmine/jasmine/master/images/jasmine-horizontal.svg" width="400px" />](http://jasmine.github.io)</a>
2
3[![Build Status](https://travis-ci.org/jasmine/jasmine.svg?branch=master)](https://travis-ci.org/jasmine/jasmine)
4[![Code Climate](https://codeclimate.com/github/pivotal/jasmine.svg)](https://codeclimate.com/github/pivotal/jasmine)
5
6=======
7
8**A JavaScript Testing Framework**
9
10Jasmine is a Behavior Driven Development testing framework for JavaScript. It does not rely on browsers, DOM, or any JavaScript framework. Thus it's suited for websites, [Node.js](http://nodejs.org) projects, or anywhere that JavaScript can run.
11
12Documentation & guides live here: [http://jasmine.github.io](http://jasmine.github.io/)
13For a quick start guide of Jasmine 2.x, see the beginning of [http://jasmine.github.io/edge/introduction.html](http://jasmine.github.io/edge/introduction.html)
14
15Upgrading from Jasmine 1.x? Check out the [2.0 release notes](https://github.com/jasmine/jasmine/blob/v2.0.0/release_notes/20.md) for a list of what's new (including breaking interface changes). You can also read the [upgrade guide](http://jasmine.github.io/2.0/upgrading.html).
16
17## Contributing
18
19Please read the [contributors' guide](https://github.com/jasmine/jasmine/blob/master/.github/CONTRIBUTING.md)
20
21## Installation
22
23For the Jasmine NPM module:<br>
24[https://github.com/jasmine/jasmine-npm](https://github.com/jasmine/jasmine-npm)
25
26For the Jasmine Ruby Gem:<br>
27[https://github.com/jasmine/jasmine-gem](https://github.com/jasmine/jasmine-gem)
28
29For the Jasmine Python Egg:<br>
30[https://github.com/jasmine/jasmine-py](https://github.com/jasmine/jasmine-py)
31
32For the Jasmine headless browser gulp plugin:<br>
33[https://github.com/jasmine/gulp-jasmine-browser](https://github.com/jasmine/gulp-jasmine-browser)
34
35To install Jasmine standalone on your local box (where **_{#.#.#}_** below is substituted by the release number downloaded):
36
37* Download the standalone distribution for your desired release from the [releases page](https://github.com/jasmine/jasmine/releases)
38* Create a Jasmine directory in your project - `mkdir my-project/jasmine`
39* Move the dist to your project directory - `mv jasmine/dist/jasmine-standalone-{#.#.#}.zip my-project/jasmine`
40* Change directory - `cd my-project/jasmine`
41* Unzip the dist - `unzip jasmine-standalone-{#.#.#}.zip`
42
43Add the following to your HTML file:
44
45```html
46<link rel="shortcut icon" type="image/png" href="jasmine/lib/jasmine-core/jasmine_favicon.png">
47<link rel="stylesheet" type="text/css" href="jasmine/lib/jasmine-core/jasmine.css">
48
49<script type="text/javascript" src="jasmine/lib/jasmine-core/jasmine.js"></script>
50<script type="text/javascript" src="jasmine/lib/jasmine-core/jasmine-html.js"></script>
51<script type="text/javascript" src="jasmine/lib/jasmine-core/boot.js"></script>
52```
53
54## Supported environments
55
56Jasmine tests itself across many browsers (Safari, Chrome, Firefox, PhantomJS, and new Internet Explorer) as well as node. To see the exact version tests are run against look at our [.travis.yml](https://github.com/jasmine/jasmine/blob/master/.travis.yml)
57
58
59## Support
60
61* Search past discussions: [http://groups.google.com/group/jasmine-js](http://groups.google.com/group/jasmine-js)
62* Send an email to the list: [jasmine-js@googlegroups.com](mailto:jasmine-js@googlegroups.com)
63* View the project backlog at Pivotal Tracker: [http://www.pivotaltracker.com/projects/10606](http://www.pivotaltracker.com/projects/10606)
64* Follow us on Twitter: [@JasmineBDD](http://twitter.com/JasmineBDD)
65
66## Maintainers
67
68* [Gregg Van Hove](mailto:gvanhove@pivotal.io), Pivotal Labs
69
70### Maintainers Emeritus
71
72* [Davis W. Frank](mailto:dwfrank@pivotal.io), Pivotal Labs
73* [Rajan Agaskar](mailto:rajan@pivotal.io), Pivotal Labs
74* [Greg Cobb](mailto:gcobb@pivotal.io), Pivotal Labs
75* [Chris Amavisca](mailto:camavisca@pivotal.io), Pivotal Labs
76* [Christian Williams](mailto:antixian666@gmail.com), Cloud Foundry
77* Sheel Choksi
78
79Copyright (c) 2008-2017 Pivotal Labs. This software is licensed under the MIT License.