From d2bf6062cbfc899c1794c047e4bde0ffd8f72dc6 Mon Sep 17 00:00:00 2001 From: Steve Gravrock Date: Sat, 9 Apr 2022 11:20:54 -0700 Subject: [PATCH] README updates * Replaced redundant installation instructions with link to docs * Added links to usage instructions * Fixes #1941 --- README.md | 33 ++++++++------------------------- 1 file changed, 8 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 978473f8..3f7c9153 100644 --- a/README.md +++ b/README.md @@ -20,37 +20,20 @@ Please read the [contributors' guide](https://github.com/jasmine/jasmine/blob/ma ## Installation -For the Jasmine NPM module:
-[https://github.com/jasmine/jasmine-npm](https://github.com/jasmine/jasmine-npm). +There are several different ways to install Jasmine, depending on your +environment and how you'd like to use it. See the [Getting Started page](https://jasmine.github.io/pages/getting_started.html) +for details. -For the Jasmine browser runner:
-[https://github.com/jasmine/jasmine-browser](https://github.com/jasmine/jasmine-browser). +## Usage -To install Jasmine standalone on your local box (where **_{#.#.#}_** below is substituted by the release number downloaded): - -* Download the standalone distribution for your desired release from the [releases page](https://github.com/jasmine/jasmine/releases). -* Create a Jasmine directory in your project. - `mkdir my-project/jasmine` -* Move the dist to your project directory. - `mv jasmine/dist/jasmine-standalone-{#.#.#}.zip my-project/jasmine` -* Change directory. - `cd my-project/jasmine` -* Unzip the dist. - `unzip jasmine-standalone-{#.#.#}.zip` - -Add the following to your HTML file: - -```html - - - - - - - - -``` +See the [documentation site](https://jasmine.github.io/pages/docs_home.html), +particularly the [Your First Suite tutorial](https://jasmine.github.io/tutorials/your_first_suite) +for information on writing specs. ## Supported environments Jasmine tests itself across popular browsers (Safari, Chrome, Firefox, and -Microsoft Edge) as well as nodejs. +Microsoft Edge) as well as Node. | Environment | Supported versions | |-------------------|--------------------|