After version 0.3.0: regularjs change the default TAG from `{{}}` to the more clean`{}`, please use `Regular.config({BEGIN:'{{', END: '}}'})` if you need the old syntax`
+> After version 0.3.0: in Regularjs, the default TAG is changed from `{{}}` to the cleaner`{}`. However you can use `Regular.config({BEGIN:'{{', END: '}}'})` if the old syntax is needed. # Regularjs [](http://travis-ci.org/regularjs/regular) -> Regularjs is a __living template engine__ that helping us to create data-driven component. +> Regularjs is a __living template engine__ that helps us to create data-driven components. ## Features -- __String-based template__ make it flexible to build your component. -- __data-binding__ is based on dirty-check, angular experience also make sense to regularjs -- __self-contained and well encapsulation__, make it be easily integrated with other framework -- __composite component__ , using component as 'custom element'. -- __directive, filter, event and animation...__ all you need is provided out of box with __concise API__ +- __String-based templates__ make it flexible to build your component; +- __data-binding__ based on dirty-check: the Angular-like experience also makes sense to regularjs; +- __self-contained and well-defined encapsulation__ makes it more easily integrated with other frameworks; +- __composite components__: components can be used as "custom elements"; +- __directive, filter, event and animation...__ all you need is provided out of box with __concise API__. @@ -42,7 +42,7 @@ var note = new Note().$inject("#app"); __[Example1 on codepen.io](http://codepen.io/leeluolee/pen/JqAaH)__ - the Example is dead simple, but you can find the directive and attribute is easily switched by statement 'if'. which is difficult with other mvvm framework. + the Example is dead simple, but you can find the directive and attribute is easily switched by statement 'if'. which is difficult with other mvvm frameworks. ### Example 2: __define a List Component__ @@ -62,14 +62,14 @@ var list = new NoteList({ ``` -In this Example, we create a ListView by statement `list`. +In this Example, we create a ListView by the statement `list`. __[Example2 on codepen.io](http://codepen.io/leeluolee/pen/mAKlL)__ ### Example 3: combine Note with NoteList -we need refactor Note to make it composable. +we need to refactor Note to make it composable. ```javascript var Note = Regular.extend({ @@ -87,11 +87,11 @@ var Note = Regular.extend({ Regular.component('list', NoteList); // manual register a component ``` -when 'Enter' is pressed, we emit a 'post' event with the `draft` as the $event object. +When 'Enter' is pressed, we emit a 'post' event with the `draft` as the $event object. -> the `this` in template is pointing to the component self. +> The keyword `this` in the template points to the component itself. -then, define Core Component: NoteApp. +Then, define the core component: NoteApp. ```javascript var NoteApp = Regular.extend({ @@ -108,7 +108,7 @@ noteapp.$inject('#app'); ``` -you can register a component(via attribute `name` or method `Component.component`) to make them composable in other component. +you can register a component (via attribute `name` or method `Component.component`) to make it composable in other components. __[Example3 on codepen.io](http://codepen.io/leeluolee/pen/bqkLp)__ @@ -123,7 +123,7 @@ See more on [Guide: Quirk Start](http://regularjs.github.io/guide/en/getting-sta ## Browser Compatibility -IE7+ and other modern browser. +IE7+ and other modern browsers. ## installation @@ -134,7 +134,7 @@ IE7+ and other modern browser. bower install regularjs ``` -`dist/regular.js` have been packaged as a standard UMD, you can use it in AMD、commonjs and global. +`dist/regular.js` has been packaged as a standard UMD, and therefore you can use it in AMD, commonjs and global. ### npm (browserify or other based on commonjs) @@ -151,7 +151,7 @@ var Regular = require('regularjs'); ### component -```js +``` component install regularjs/regular ``` use @@ -162,41 +162,38 @@ var Regular = require('regularjs/regular'); -### Directly download +### Direct download 1. [regular.js](https://rawgit.com/regularjs/regular/master/dist/regular.js) 2. [regular.min.js](https://rawgit.com/regularjs/regular/master/dist/regular.min.js) -## Who are using ? +## Who are using? -1. [NetEase](https://github.com/NetEase) : operator of famous [www.163.com](http://www.163.com). +1. [NetEase](https://github.com/NetEase): the operator of the famous website [www.163.com](http://www.163.com). ## Community -* If you find bugs or have suggestion, please feel free to open [an issue](https://github.com/regularjs/regular/issues) +* If you find bugs or have suggestions, please feel free to open [an issue](https://github.com/regularjs/regular/issues) * Ask any questions on [Stack Overflow](http://stackoverflow.com/questions/tagged/regularjs) with tag `regularjs`. * Social 1. twitter: follow the [@regularjs](https://twitter.com/regularjs). - 3. gitter: talk on [](https://gitter.im/regularjs/regular) - 2. weibo: [@拴萝卜的棍子](http://weibo.com/luobolee) + 1. gitter: talk on [](https://gitter.im/regularjs/regular) + 1. weibo: [@拴萝卜的棍子](http://weibo.com/luobolee) ## Contribute -__regularjs is still in heavily development__, helping us with feedback. there is some recommend to contributor. +__regularjs is still in heavily development__, and please help us with feedback. Contributing to this project is also recommended. -* Please [open issue](https://github.com/regularjs/regular/issues) before sending pull request, -* if needed, add your testcase at `test/specs` folder. always make sure the `gulp test` is passed, and the `test/runner/index.html` is passed in every target browser (if you doesn't have some browser installed that list in [gulpfile's karmaConfig](https://github.com/regularjs/regular/blob/master/gulpfile.js#L30)) +* Please [open an issue](https://github.com/regularjs/regular/issues) before sending pull request, +* if needed, add your testcase at `test/specs` folder. always make sure the `gulp test` is passed, and the `test/runner/index.html` is passed in every target browser (if a certain browser is not installed, list that in [gulpfile's karmaConfig](https://github.com/regularjs/regular/blob/master/gulpfile.js#L30)) ## LICENSE [MIT](https://github.com/regularjs/regular/blob/master/LICENSE). - - -