UNPKG

1.71 kBMarkdownView Raw
1![mout](http://moutjs.com/logo.png "Modular JavaScript Utilties")
2
3http://moutjs.com/
4
5[![Build Status](https://travis-ci.org/mout/mout.png?branch=master)](https://travis-ci.org/mout/mout)
6
7All code is library agnostic and consist mostly of helper methods that aren't
8directly related with the DOM, the purpose of this library isn't to replace
9Dojo, jQuery, YUI, Mootools, etc, but to provide modular solutions for common
10problems that aren't solved by most of them. Consider it as a crossbrowser
11JavaScript standard library.
12
13
14
15## Main goals ##
16
17 - increase code reuse;
18 - be clear (code should be clean/readable);
19 - be easy to debug;
20 - be easy to maintain;
21 - follow best practices;
22 - follow standards when possible;
23 - **don't convert JavaScript into another language!**
24 - be compatible with other frameworks;
25 - be modular;
26 - have unit tests for all modules;
27 - work on multiple environments (IE7+, modern browsers, node.js);
28
29
30
31## What shouldn't be here ##
32
33 - UI components;
34 - CSS selector engine;
35 - Event system - pub/sub;
36 - Template engine;
37 - Anything that isn't generic enough to be on a standard library;
38 - Anything that could be a separate library and/or isn't a modular utility...
39
40
41
42## API Documentation ##
43
44Online documentation can be found at http://moutjs.com/ or inside the
45`doc` folder.
46
47
48
49## FAQ / Wiki / IRC ##
50
51For more info about project structure, design decisions, tips, how to
52contribute, build system, etc, please check the [project
53wiki](https://github.com/mout/mout/wiki).
54
55We also have an IRC channel [#moutjs on
56irc.freenode.net](http://webchat.freenode.net/)
57
58
59
60## License ##
61
62Released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).
63