Permalink
Browse files

Updated README and CONTRIBUTING

This also updates the LICENSE year. [ci skip]
  • Loading branch information...
1 parent 05d8407 commit 5c71e2da5099adc9ca73bb9071fa5914de7d4661 @kevin-brown kevin-brown committed Jan 10, 2015
Showing with 29 additions and 39 deletions.
  1. +13 −2 CONTRIBUTING.md
  2. +1 −1 LICENSE.md
  3. +13 −34 README.md
  4. +2 −2 select2.jquery.json
View
@@ -45,7 +45,7 @@ to are:
- What version of jQuery are you using? And what version of Select2?
- Are you using Select2 with other plugins?
-All of these questions will help people fix and identify any potential bugs.
+All of these questions will help others fix and identify any potential bugs.
Requesting features in Select2
------------------------------
@@ -84,9 +84,20 @@ the community before being accepted. If you are not sure about a piece of
submitted code, or know of a better way to do something, do not hesitate to make
a comment on the pull request.
+### Reviving old tickets
+
+If you come across tickets which have not been updated for a while, you are
+encouraged to revive them. While this can be as simple as saying `:+1:`, it is
+best if you can include more information on the issue. Common bugs and feature
+requests are more likely to be fixed, whether it is by the community or the
+developers, so keeping tickets up to date is encouraged.
+
+Licensing
+---------
+
It should also be made clear that **all code contributed to Select** must be
licensable under the [MIT license][licensing]. Code that cannot be released
-under either of these licenses **cannot be accepted** into the project.
+under this license **cannot be accepted** into the project.
[community]: https://select2.github.io/community.html
[reporting-bugs]: #reporting-bugs-with-select2
View
@@ -1,6 +1,6 @@
The MIT License (MIT)
-Copyright (c) 2012-2014 Kevin Brown, Igor Vaynberg, and Select2 contributors
+Copyright (c) 2012-2015 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
View
@@ -1,23 +1,26 @@
Select2
=======
-
[![Build Status][travis-ci-image]][travis-ci-status]
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://select2.github.io/
+https://select2.github.io/
Use cases
---------
* Enhancing native selects with search.
* Enhancing native selects with a better multi-select interface.
-* Loading data from JavaScript: easily load items via ajax and have them searchable.
-* Nesting optgroups: native selects only support one level of nested. Select2 does not have this restriction.
+* Loading data from JavaScript: easily load items via AJAX and have them
+ searchable.
+* Nesting optgroups: native selects only support one level of nesting. Select2
+ does not have this restriction.
* Tagging: ability to add new items on the fly.
-* Working with large, remote datasets: ability to partially load a dataset based on the search term.
-* Paging of large datasets: easy support for loading more pages when the results are scrolled to the end.
+* Working with large, remote datasets: ability to partially load a dataset based
+ on the search term.
+* Paging of large datasets: easy support for loading more pages when the results
+ are scrolled to the end.
* Templating: support for custom rendering of results and selections.
Browser compatibility
@@ -36,7 +39,6 @@ the integrations below.
Integrations
------------
-
* [Wicket-Select2][wicket-select2] (Java / [Apache Wicket][wicket])
* [select2-rails][select2-rails] (Ruby on Rails)
* [AngularUI][angularui-select] ([AngularJS][angularjs])
@@ -53,7 +55,6 @@ Integrations
Internationalization (i18n)
---------------------------
-
Select2 supports multiple languages by simply including the right language JS
file (`dist/js/i18n/it.js`, `dist/js/i18n/nl.js`, etc.) after
`dist/js/select2.js`.
@@ -63,37 +64,14 @@ make a pull request back to Select2 here on GitHub.
Documentation
-------------
-
The documentation for Select2 is available
[through GitHub Pages][documentation] and is located within this repository
-in the [docs folder][documentation-folder].
+in the [`docs` folder][documentation-folder].
Community
---------
-
-### Bug tracker
-
-Have a bug? Please create an issue here on GitHub!
-
-https://github.com/select2/select2/issues
-
-### Mailing list
-
-Have a question? Ask on our mailing list!
-
-select2@googlegroups.com
-
-https://groups.google.com/d/forum/select2
-
-### IRC channel
-
-Need help implementing Select2 in your project? Ask in our IRC channel!
-
-**Network:** [Freenode][freenode] (`chat.freenode.net`)
-
-**Channel:** `#select2`
-
-**Web access:** https://webchat.freenode.net/?channels=select2
+You can find out about the different ways to get in touch with the Select2
+community at the [Select2 community page][community].
Copyright and license
---------------------
@@ -105,6 +83,7 @@ The license is available within the repository in the [LICENSE][license] file.
[bootstrap2-select2]: https://github.com/t0m/select2-bootstrap-css
[bootstrap3-select2]: https://github.com/t0m/select2-bootstrap-css/tree/bootstrap3
[cdnjs]: http://www.cdnjs.com/libraries/select2
+[community]: https://select2.github.io/community.html
[django-select2]: https://github.com/applegrew/django-select2
[documentation]: https://select2.github.io/
[documentation-folder]: https://github.com/select2/select2/tree/master/docs
View
@@ -13,8 +13,8 @@
],
"version": "4.0.0-beta.1",
"author": {
- "name": "Igor Vaynberg",
- "url": "https://github.com/ivaynberg"
+ "name": "Kevin Brown",
+ "url": "https://github.com/kevin-brown"
},
"licenses": [
{

0 comments on commit 5c71e2d

Please sign in to comment.