UNPKG

2.5 kBMarkdownView Raw
1# [Phonon](http://phonon.quarkdev.com)
2
3> Phonon: the light weight, scalable, flexible and customizable HTML5 Web - Mobile Framework.
4
5[![TypeScript](https://badges.frapsoft.com/typescript/code/typescript.svg?v=101)](https://github.com/ellerbrock/typescript-badges/)
6[![Dependency Status](https://david-dm.org/quark-dev/Phonon-Framework.svg)](https://david-dm.org/quark-dev/Phonon-Framework)
7[![devDependencies Status](https://david-dm.org/quark-dev/Phonon-Framework/dev-status.svg)](https://david-dm.org/quark-dev/Phonon-Framework)
8[![Build Status](https://img.shields.io/travis/quark-dev/Phonon-Framework.svg?style=flat-square)](https://travis-ci.org/quark-dev/Phonon-Framework)
9[![Codecov](https://img.shields.io/codecov/c/github/quark-dev/Phonon-Framework.svg?style=flat-square)](https://codecov.io/gh/quark-dev/Phonon-Framework)
10[![npm](https://img.shields.io/npm/v/phonon.svg?style=flat-square)]()
11[![license](https://img.shields.io/github/license/quark-dev/phonon.svg?style=flat-square)]()
12[![GitHub contributors](https://img.shields.io/github/contributors/quark-dev/phonon.svg?style=flat-square)]()
13
14Starting with v2.0, Phonon takes full advantage of ECMAScript.
15
16## Quick start
17
18Please refer to our documentation for more information.
19
20The installation can take place in several ways:
21
22- [Download the latest release](https://github.com/quark-dev/Phonon-Framework/releases) and use dist files.
23- Clone the repo: `git clone https://github.com/quark-dev/Phonon-Framework.git`.
24- Install with [npm](https://www.npmjs.com): `npm install phonon`.
25- Install with [yarn](https://yarnpkg.com/en/): `yarn add phonon`.
26- Install with [Bower](https://bower.io): `bower install phonon`.
27- Use [CDNJS](https://cdnjs.com/libraries/PhononJs).
28
29
30## Versioning
31
32Phonon Framework is maintained under the [Semantic Versioning guidelines](http://semver.org/).
33
34
35## Contributing
36
37**Don't hesitate** to contribute to this project! The Phonon team is completely open to any suggestions or improvements. Please, go to the [issues page](https://github.com/quark-dev/Phonon-Framework/issues) to open an issue.
38Moreover, if your pull request contains JavaScript patches or features, you must include relevant unit tests.
39Editor preferences are available in the [editor config](https://github.com/quark-dev/Phonon-Framework/blob/master/.editorconfig) for easy use in common text editors.
40
41
42## Copyright and license
43
44Code released under the [MIT License](https://github.com/quark-dev/Phonon-Framework/blob/master/LICENSE).