Skip to content

Commit

Permalink
README fixes
Browse files Browse the repository at this point in the history
 * Wrap to 80 lines.
 * QUnit is no longer submodule.
 * Added details on running tests.
  • Loading branch information
kartikm committed Mar 13, 2014
1 parent 0d8f64a commit 2ac6b18
Showing 1 changed file with 36 additions and 17 deletions.
53 changes: 36 additions & 17 deletions README.md
Expand Up @@ -5,40 +5,59 @@ jQuery based webfonts extension. This is a project by Wikimedia foundation's [La

## Introduction

jQuery WebFonts extension adds font embedding capability to jquery using the WebFonts technology. The extension provides a flexible way to choose font from a font repository and apply on html elements.
jQuery WebFonts extension adds font embedding capability to jquery using the
WebFonts technology. The extension provides a flexible way to choose font from
a font repository and apply on html elements.

## Features

* Flexible font repository. The extension can work with any font repository file system. See [more..](https://github.com/wikimedia/jquery.webfonts/wiki/Font-Repository)
* Provides many APIs to customize and extend. See [more...](https://github.com/wikimedia/jquery.webfonts/wiki/API)
* Flexible font repository. The extension can work with any font repository
file system.
See [more..](https://github.com/wikimedia/jquery.webfonts/wiki/Font-Repository)
* Provides many APIs to customize and extend.
See [more...](https://github.com/wikimedia/jquery.webfonts/wiki/API)
* Applies font based on the html `lang` attribute of the elements
* Make sure the font defined using `font-family` style for any elements, either using inline css or external css' available for the reader. - without any extra code. See [Examples](https://github.com/wikimedia/jquery.webfonts/wiki/Examples)
* Make sure the font defined using `font-family` style for any elements,
either using inline css or external css' available for the reader without
any extra code.
See [Examples](https://github.com/wikimedia/jquery.webfonts/wiki/Examples)

For examples, API, and usage information, please visit [wiki](https://github.com/wikimedia/jquery.webfonts/wiki)
For examples, API, and usage information, please visit
[wiki](https://github.com/wikimedia/jquery.webfonts/wiki)

## Test

Before you can run the tests, make sure the submodules are updated:
If you have python installed, run
```bash
python -m SimpleHTTPServer
```
git submodule update --init
or, In case you have python3
```bash
python3 -m http.server
```
or, with PHP
```bash
php -S localhost:8000
```
and, you can run tests from
```bash
http://localhost:8000/tests/

Then open up `./test/index.html` in your browser.

Some browsers will not be able to load JSON using AJAX if you run
the tests as local files (file://), so you should run them from
a web server (http://).
Since some browsers will not be able to load JSON using AJAX if you run the
tests as local files (file://), so you should run them from a web server
(http://).

## License

You may use jquery.webfonts under the terms of either the MIT License or the GNU General
Public License (GPL) Version 2 or later.
You may use jquery.webfonts under the terms of either the MIT License or the
GNU General Public License (GPL) Version 2 or later.

See GPL-LICENSE and MIT-LICENSE for details.

## Developers

This project is part of Wikimedia Foundation's Project Milkshake. See https://www.mediawiki.org/wiki/Project_Milkshake.
This project is part of Wikimedia Foundation's Project Milkshake.
See https://www.mediawiki.org/wiki/Project_Milkshake.
For details on how Wikimedia is using this extension for providing webfonts to wikis,
read https://www.mediawiki.org/wiki/Universal_Language_Selector/WebFonts
For details on how Wikimedia is using this extension for providing webfonts to
wikis, read https://www.mediawiki.org/wiki/Universal_Language_Selector/WebFonts

0 comments on commit 2ac6b18

Please sign in to comment.