Skip to content

Commit 0928d49

Browse files
author
Tortue Torche
committed
Update README.md
1 parent 8a102e7 commit 0928d49

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@ This package provides:
66

77
* jQuery 1.11.1
88
* the jQuery UJS adapter
9-
9+
1010
TODO:
11-
11+
1212
* assert_select_jquery to test jQuery responses in PHP tests
1313

1414
## Versions
1515

16-
The jquery-laravel package follows these version guidelines
17-
to provide more control over your app's jquery version from your `composer.json` file:
16+
The `jquery-laravel` package follows these version guidelines
17+
to provide more control over your app's jQuery version from your `composer.json` file:
1818

1919
```
20-
patch version bump = updates to jquery-ujs, jquery-laravel, and patch-level updates to jquery
21-
minor version bump = minor-level updates to jquery
22-
major version bump = major-level updates to jquery and updates to laravel which may be backwards-incompatible
20+
patch version bump = updates to jquery-ujs, jquery-laravel, and patch-level updates to jQuery
21+
minor version bump = minor-level updates to jQuery
22+
major version bump = major-level updates to jQuery and updates to Laravel/Larasset which may be backwards-incompatible
2323
```
2424

2525
## Prerequisites
@@ -30,9 +30,9 @@ This package is **only** compatible with **PHP >= 5.4** and **Laravel >= 4.1** f
3030

3131
## Installation
3232

33-
[Laravel](http://laravel.com) apps with [Larasset](https://github.com/efficiently/larasset) package include jquery-laravel by default.
33+
[Laravel](http://laravel.com) apps with [Larasset](https://github.com/efficiently/larasset) package include `jquery-laravel` by default.
3434

35-
1. So just make a new app
35+
1. So just make a new app
3636

3737
```sh
3838
composer create-project laravel/laravel your-project-name --prefer-dist
@@ -48,9 +48,7 @@ This package is **only** compatible with **PHP >= 5.4** and **Laravel >= 4.1** f
4848

4949
Click [here](https://github.com/efficiently/larasset/blob/master/README.md#installation) to follow the installation instructions of this package.
5050

51-
### Laravel 4.1 or greater (with Larasset package *installed*)
52-
53-
The jquery and jquery-ujs files will be added to the asset pipeline and available for you to use.
51+
NOTE: The `jquery.js` and `jquery-ujs.js` files will be added to the asset pipeline and available for you to use.
5452
If they're not already in `app/assets/javascripts/application.js` by default, add these lines:
5553
5654
```js
@@ -62,9 +60,13 @@ If they're not already in `app/assets/javascripts/application.js` by default, ad
6260
6361
Feel free to open an issue ticket if you find something that could be improved. A couple notes:
6462
65-
* If it's an issue pertaining to the jquery-ujs javascript, please report it to the [jquery-ujs project](https://github.com/rails/jquery-ujs).
63+
* If it's an issue pertaining to the `jquery-ujs` javascript, please report it to the [jquery-ujs project](https://github.com/rails/jquery-ujs).
64+
65+
* If the jQuery scripts are outdated (i.e. maybe a new version of jQuery was released yesterday), feel free to open an issue and prod us to get that thing updated. However, for security reasons, we won't be accepting pull requests with updated jQuery scripts.
66+
67+
## Credits
6668
67-
* If the jquery scripts are outdated (i.e. maybe a new version of jquery was released yesterday), feel free to open an issue and prod us to get that thing updated. However, for security reasons, we won't be accepting pull requests with updated jquery scripts.
69+
This package is a port of the [jquery-rails](https://github.com/rails/jquery-rails) gem from the Ruby on Rails framework.
6870
6971
## Acknowledgements
7072

0 commit comments

Comments
 (0)