Skip to content

Commit 2d82baa

Browse files
Separate the installation docs in sections
Closes js-cookiegh-182. Closes js-cookiegh-177.
1 parent 81e202a commit 2d82baa

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ A simple, lightweight JavaScript API for handling cookies
2626

2727
## Installation
2828

29-
Include the script (unless you are packaging scripts somehow else):
29+
### Direct download
30+
31+
Download the script [here](https://github.com/js-cookie/js-cookie/blob/v2.1.1/src/js.cookie.js) and include it (unless you are packaging scripts somehow else):
3032

3133
```html
3234
<script src="/path/to/js.cookie.js"></script>
@@ -35,9 +37,13 @@ Include the script (unless you are packaging scripts somehow else):
3537
**Do not include the script directly from GitHub (http://raw.github.com/...).** The file is being served as text/plain and as such being blocked
3638
in Internet Explorer on Windows 7 for instance (because of the wrong MIME type). Bottom line: GitHub is not a CDN.
3739

38-
js-cookie supports [npm](https://www.npmjs.com/package/js-cookie) and [Bower](http://bower.io/search/?q=js-cookie) under the name `js-cookie`
40+
### Package Managers
41+
42+
JavaScript Cookie supports [npm](https://www.npmjs.com/package/js-cookie) and [Bower](http://bower.io/search/?q=js-cookie) under the name `js-cookie`.
43+
44+
### Module Loaders
3945

40-
It can also be loaded as an AMD or CommonJS module.
46+
JavaScript Cookie can also be loaded as an AMD or CommonJS module.
4147

4248
## Basic Usage
4349

@@ -271,6 +277,7 @@ Check out the [Contributing Guidelines](CONTRIBUTING.md)
271277
* Create version tag in git
272278
* Create a github release and upload the minified file
273279
* Link the documentation of the latest release tag in the `README.md`
280+
* Link the download link to the latest release tag in the `README.md`
274281
* Commit with the message "Prepare for the next development iteration"
275282
* Release on npm
276283

0 commit comments

Comments
 (0)