Updated README
Change-Id: I527516ea52ffe3a1d28f3e4d386c50ed8b6acad1
This commit is contained in:
71
README.md
71
README.md
@@ -1,19 +1,66 @@
|
||||
jQuery Universal Language Selector
|
||||
jQuery Universal Language Selector
|
||||
==================================
|
||||
Universal Language Selector
|
||||
|
||||
Introduction
|
||||
-------------
|
||||
[](http://travis-ci.org/wikimedia/jquery.uls)
|
||||
|
||||
|
||||
|
||||
Preparing language data
|
||||
------------------------
|
||||
|
||||
The language names, autonyms, region informations are present in src/jquery.uls.data.js.
|
||||
But this file is auto generated from data/langdb.yaml. If you want to make any changes to the
|
||||
language data, edit data/langdb.yaml and generate the src/jquery.uls.data.js using
|
||||
Quick start
|
||||
-----------
|
||||
|
||||
```bash
|
||||
php ulsdata2json.php
|
||||
git clone https://github.com/wikimedia/jquery.uls.git
|
||||
```
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
For documentation and examples please visit the [wiki](https://github.com/wikimedia/jquery.uls/wiki/_pages)
|
||||
|
||||
|
||||
How to build and test jQuery i18n
|
||||
----------------------------------
|
||||
|
||||
First, get a copy of the git repo by running:
|
||||
|
||||
```shell
|
||||
git clone git://github.com/wikimedia/jquery.uls.git
|
||||
```
|
||||
|
||||
Make sure you have `grunt` installed by testing:
|
||||
|
||||
```shell
|
||||
grunt -version
|
||||
```
|
||||
|
||||
If not, run:
|
||||
|
||||
```shell
|
||||
npm install
|
||||
```
|
||||
|
||||
To run tests locally, run `grunt`, and this will run the tests in PhantomJS.
|
||||
|
||||
You can also run the tests in a browser by navigating to the `test/` directory, but first run `grunt` to install submodules.
|
||||
|
||||
Coding style
|
||||
-------------
|
||||
|
||||
Please follow [jQuery coding guidelines](http://docs.jquery.com/JQuery_Core_Style_Guidelines)
|
||||
|
||||
Versioning
|
||||
----------
|
||||
|
||||
For transparency and insight into the release cycle, and to upgrading easier,
|
||||
we use the Semantic Versioning guidelines as much as possible.
|
||||
|
||||
Releases will be numbered with the following format:
|
||||
|
||||
`<major>.<minor>.<patch>`
|
||||
|
||||
And constructed with the following guidelines:
|
||||
|
||||
* Breaking backward compatibility bumps the major (and resets the minor and patch)
|
||||
* New additions without breaking backward compatibility bumps the minor (and resets the patch)
|
||||
* Bug fixes and misc changes bumps the patch
|
||||
|
||||
For more information on SemVer, please visit http://semver.org/.
|
||||
|
||||
Reference in New Issue
Block a user