Skip to content

Commit c0e442d

Browse files
committed
Update Readme badges
1 parent 35e9247 commit c0e442d

File tree

1 file changed

+31
-19
lines changed

1 file changed

+31
-19
lines changed

Diff for: README.md

+31-19
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[![NPM version](http://img.shields.io/npm/v/selectize.svg?style=flat)](https://www.npmjs.org/package/selectize)
66
[![CDNJS version](http://img.shields.io/cdnjs/v/selectize.js.svg?style=flat)](https://cdnjs.com/libraries/selectize.js)
77
[![Build Status](http://img.shields.io/travis/selectize/selectize.js/master.svg?style=flat)](https://travis-ci.org/selectize/selectize.js)
8+
![Node.js CI](https://github.com/selectize/selectize.js/workflows/Node.js%20CI/badge.svg)
89
[![Coverage Status](http://img.shields.io/coveralls/selectize/selectize.js/master.svg?style=flat)](https://coveralls.io/r/selectize/selectize.js)
910

1011
Selectize is an extensible [jQuery](http://jquery.com/)-based custom <select> UI control. It's useful for tagging, contact lists, country selectors, and so on. It clocks in at around ~7kb (gzipped). The goal is to provide a solid & usable experience with a clean and powerful API.
@@ -17,17 +18,26 @@ Selectize is an extensible [jQuery](http://jquery.com/)-based custom <select&
1718
- [Plugin Documentation](docs/plugins.md)
1819
- [Browser Test Matrix](https://saucelabs.com/u/selectize)
1920

20-
### Features
21-
22-
- **Smart Option Searching / Ranking**<br>Options are efficiently scored and sorted on-the-fly (using [sifter](https://github.com/brianreavis/sifter.js)). Want to search an item's title *and* description? No problem.
23-
- **Caret between items**<br>Order matters sometimes. Use the <kbd>&larr;</kbd> and <kbd>&rarr;</kbd> arrow keys to move between selected items.</li>
24-
- **Select &amp; delete multiple items at once**<br>Hold down <kbd>option</kbd> on Mac or <kbd>ctrl</kbd> on Windows to select more than one item to delete.
25-
- **Díåcritîçs supported**<br>Great for international environments.
26-
- **Item creation**<br>Allow users to create items on the fly (async saving is supported; the control locks until the callback is fired).
27-
- **Remote data loading**<br>For when you have thousands of options and want them provided by the server as the user types.
28-
- **Clean API &amp; code**<br>Interface with it and make modifications easily. Pull requests welcome!
29-
- **Extensible**<br> [Plugin API](docs/plugins.md) for developing custom features (uses [microplugin](https://github.com/brianreavis/microplugin.js)).
30-
- **Touch Support**<br> Plays nice with iOS 5+ devices.
21+
## Features
22+
23+
- **Smart Option Searching / Ranking**
24+
Options are efficiently scored and sorted on-the-fly (using [sifter](https://github.com/brianreavis/sifter.js)). Want to search an item's title *and* description? No problem.
25+
- **Caret between items**
26+
Order matters sometimes. Use the <kbd>&larr;</kbd> and <kbd>&rarr;</kbd> arrow keys to move between selected items.</li>
27+
- **Select &amp; delete multiple items at once**
28+
Hold down <kbd>option</kbd> on Mac or <kbd>ctrl</kbd> on Windows to select more than one item to delete.
29+
- **Díåcritîçs supported**
30+
Great for international environments.
31+
- **Item creation**
32+
Allow users to create items on the fly (async saving is supported; the control locks until the callback is fired).
33+
- **Remote data loading**
34+
For when you have thousands of options and want them provided by the server as the user types.
35+
- **Clean API &amp; code**
36+
Interface with it and make modifications easily. Pull requests welcome!
37+
- **Extensible**
38+
[Plugin API](docs/plugins.md) for developing custom features (uses [microplugin](https://github.com/brianreavis/microplugin.js)).
39+
- **Touch Support**
40+
Plays nice with iOS 5+ devices.
3141

3242
### Dependencies
3343

@@ -94,14 +104,15 @@ grunt --plugins=remove_button,restore_on_backspace
94104
```
95105

96106
### Contributing
107+
97108
When issuing a pull request:
98109

99-
* please **do not include/commit changes in the `dist/` folder** to avoid
110+
- please **do not include/commit changes in the `dist/` folder** to avoid
100111
merge conflicts. A good way to include the right files is to use
101112
`git gui` or `git add` when committing to select the files you want to
102113
add to your commit.
103114

104-
* please **include tests** with your feature so that we're not tempted to
115+
- please **include tests** with your feature so that we're not tempted to
105116
break it in the future!
106117

107118
Add an entry to the top of the CHANGELOG, and update the documentation
@@ -119,22 +130,23 @@ tracked files) and `git clean [-i/--interactive]` (to erase untracked
119130
files). **However, be careful with those commands, as their function
120131
is to erase things/changes.**
121132

122-
123133
#### Tests
134+
124135
Please ensure all the tests pass:
125136

126137
```sh
127-
$ npm test # phantomjs
128-
$ BROWSERS=Firefox npm test
129-
$ BROWSERS=Firefox,Chrome npm test
130-
$ BROWSERS=Firefox,Chrome,Safari npm test
138+
npm test # phantomjs
139+
BROWSERS=Firefox npm test
140+
BROWSERS=Firefox,Chrome npm test
141+
BROWSERS=Firefox,Chrome,Safari npm test
131142
```
132143

133144
#### Local environment
145+
134146
To run Selectize locally:
135147

136148
```sh
137-
$ npm start
149+
npm start
138150
```
139151

140152
You can then run the examples in `http://localhost:8000/examples/`.

0 commit comments

Comments
 (0)