Skip to content

Commit fba5d96

Browse files
committed
Formatted the readme and package
1 parent 6ce1f59 commit fba5d96

2 files changed

Lines changed: 6 additions & 14 deletions

File tree

README.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,24 +34,16 @@ JavaScript Boilerplate is the collection of best practices using a design patter
3434

3535
2. The second step would be to define the components, which can be page level or widget level too.
3636

37-
```javascript
38-
MODULE.subModule = (function () {
3937

38+
MODULE.subModule = (function () {
4039
function _subModule() {
41-
4240
... (3)
43-
44-
4541
}
42+
return new _subModule()
43+
})();
4644

4745

48-
return new _subModule();
49-
50-
51-
})();
52-
```
53-
54-
The above code has defined a component called helper as a sub module of `MODULE` namespace. `MODULE.helper` holds an object that gets returned through `new _subModule()`. We can define all the functions that we want for the helper module inside the function `_subModule()`.
46+
The above code has defined a component called helper as a sub module of `MODULE` namespace. `MODULE.helper` holds an object that gets returned through `new _subModule()`. We can define all the functions that we want for the helper module inside the function `_subModule()`.
5547

5648

5749
3. The third step would be to define the private values, private functions , priviledged functions etc. within the `_subModule` function. Comments have been provided as to which one is a private function and which is a priviledged one. At the end of the function the `init()` function is exposed which in turn returns the object itself. When the object is returned all the priviledged functions are exposed along with it and are accessible outside.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"name" : "javascript-boilerplate",
77
"title" : "JavaScript-Boilerplate",
88
"description" : "JavaScript Boilerplate is the collection of best practices.",
9-
"keywords" : ["js-boilerplate", "boilerplate", "javascript"],
9+
"keywords" : ["javascript-boilerplate", "js-boilerplate", "boilerplate", "javascript"],
1010
"repository" : {
1111
"type" : "git",
1212
"url" : "https://github.com/mdarif/JavaScript-Boilerplate.git"
@@ -15,6 +15,6 @@
1515
},
1616
"devDependencies": {},
1717
"main" : "./js/_.main.js",
18-
"version" : "1.0.1",
18+
"version" : "1.0.2",
1919
"license" : "MIT/GPL"
2020
}

0 commit comments

Comments
 (0)