Tweak the README
Now we point users to the `LICENSE.md` file for the license, instead of including it in the README. This also removes the example integrations, which are no longer officially maintained by Select2. The translation section has also been updated.
This commit is contained in:
parent
fef1ccfd81
commit
8bf86ebae1
45
README.md
45
README.md
@ -1,9 +1,11 @@
|
|||||||
Select2
|
Select2
|
||||||
=======
|
=======
|
||||||
|
|
||||||
Select2 is a jQuery-based replacement for select boxes. It supports searching, remote data sets, and infinite scrolling of results.
|
Select2 is a jQuery-based replacement for select boxes. It supports searching,
|
||||||
|
remote data sets, and pagination of results.
|
||||||
|
|
||||||
To get started, checkout examples and documentation at http://ivaynberg.github.com/select2
|
To get started, checkout examples and documentation at
|
||||||
|
http://ivaynberg.github.io/select2
|
||||||
|
|
||||||
Use cases
|
Use cases
|
||||||
---------
|
---------
|
||||||
@ -46,23 +48,17 @@ Integrations
|
|||||||
* [Meteor][meteor-select2-alt]
|
* [Meteor][meteor-select2-alt]
|
||||||
* [Yii 2.x][yii2-select2]
|
* [Yii 2.x][yii2-select2]
|
||||||
* [Yii 1.x][yii-select2]
|
* [Yii 1.x][yii-select2]
|
||||||
* [AtmosphereJS][atomospherejs-select2]
|
* [AtmosphereJS][atmospherejs-select2]
|
||||||
|
|
||||||
### Example Integrations
|
|
||||||
|
|
||||||
* [Knockout.js](https://github.com/ivaynberg/select2/wiki/Knockout.js-Integration)
|
|
||||||
* [Socket.IO](https://github.com/ivaynberg/select2/wiki/Socket.IO-Integration)
|
|
||||||
* [PHP](https://github.com/ivaynberg/select2/wiki/PHP-Example)
|
|
||||||
* [.Net MVC] (https://github.com/ivaynberg/select2/wiki/.Net-MVC-Example)
|
|
||||||
|
|
||||||
Internationalization (i18n)
|
Internationalization (i18n)
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
Select2 supports multiple languages by simply including the right language JS
|
Select2 supports multiple languages by simply including the right language JS
|
||||||
file (`select2_locale_it.js`, `select2_locale_nl.js`, etc.) after `select2.js`.
|
file (`dist/js/i18n/it.js`, `dist/js/i18n/nl.js`, etc.) after
|
||||||
|
`dist/js/select2.js`.
|
||||||
|
|
||||||
Missing a language? Just copy `select2_locale_en.js.template`, translate
|
Missing a language? Just copy `src/js/select2/i18n/en.js`, translate it, and
|
||||||
it, and make a pull request back to Select2 here on GitHub.
|
make a pull request back to Select2 here on GitHub.
|
||||||
|
|
||||||
Documentation
|
Documentation
|
||||||
-------------
|
-------------
|
||||||
@ -100,27 +96,7 @@ Need help implementing Select2 in your project? Ask in our IRC channel!
|
|||||||
|
|
||||||
Copyright and license
|
Copyright and license
|
||||||
---------------------
|
---------------------
|
||||||
The MIT License (MIT)
|
The license is available within the repository in the [LICENSE][license] file.
|
||||||
|
|
||||||
Copyright (c) 2012-2014 Kevin Brown, Igor Vaynberg, and Select2 contributors
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in
|
|
||||||
all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
||||||
THE SOFTWARE.
|
|
||||||
|
|
||||||
[angularjs]: https://angularjs.org/
|
[angularjs]: https://angularjs.org/
|
||||||
[angularui-select]: http://angular-ui.github.io/#ui-select
|
[angularui-select]: http://angular-ui.github.io/#ui-select
|
||||||
@ -133,6 +109,7 @@ THE SOFTWARE.
|
|||||||
[documentation-folder]: https://github.com/ivaynberg/select2/tree/master/docs
|
[documentation-folder]: https://github.com/ivaynberg/select2/tree/master/docs
|
||||||
[freenode]: https://freenode.net/
|
[freenode]: https://freenode.net/
|
||||||
[jsdelivr]: http://www.jsdelivr.com/#!select2
|
[jsdelivr]: http://www.jsdelivr.com/#!select2
|
||||||
|
[license]: LICENSE.md
|
||||||
[meteor-select2]: https://github.com/nate-strauser/meteor-select2
|
[meteor-select2]: https://github.com/nate-strauser/meteor-select2
|
||||||
[meteor-select2-alt]: https://jquery-select2.meteor.com
|
[meteor-select2-alt]: https://jquery-select2.meteor.com
|
||||||
[meteor-select2-bootstrap3]: https://github.com/esperadomedia/meteor-select2-bootstrap3-css/
|
[meteor-select2-bootstrap3]: https://github.com/esperadomedia/meteor-select2-bootstrap3-css/
|
||||||
|
Loading…
Reference in New Issue
Block a user