Skip to content

Commit ceca642

Browse files
authored
update readme coding style and add alternatives
1 parent 79a8d3a commit ceca642

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

readme.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22

33
Require from a directory relative to node_modules, flattening your require paths. Using requireFrom you won't have to manage complex relative paths between each component of your node app.
44

5+
Alternatively check out [wavy](https://www.npmjs.com/package/wavy) or [link-local](https://www.npmjs.com/package/linklocal) if symlinks might be a better solution for your project.
6+
57
## Code Example
68

79
Simple usage anywhere in your node app:
810
````js
9-
var lib = require('requirefrom')('lib');
10-
var myModule = lib('myModule');
11+
let lib = require('requirefrom')('lib');
12+
let myModule = lib('myModule');
1113
````
1214

1315
For more complex usage, let's assume this example directory structure:
@@ -29,29 +31,27 @@ For more complex usage, let's assume this example directory structure:
2931

3032
Any file in this project could then include these files with the following code:
3133
````js
32-
var
33-
requireFrom = require('requirefrom')
34-
, views = requireFrom('lib/components/framework/views/')
35-
, models = requireFrom('lib/components/framework/models/')
36-
, utility = requireFrom('lib/utility/')
34+
let requireFrom = require('requirefrom');
35+
let views = requireFrom('lib/components/framework/views/');
36+
let models = requireFrom('lib/components/framework/models/');
37+
let utility = requireFrom('lib/utility/');
3738

38-
, loginForm = views('login.js')
39-
, signupForm = views('signup.js')
39+
let loginForm = views('login.js');
40+
let signupForm = views('signup.js');
4041

41-
, userModel = models('user')
42+
let userModel = models('user');
4243

43-
, normalizeUser = utility('normalize/user.js')
44+
let normalizeUser = utility('normalize/user.js');
4445
````
4546

4647
Without requireFrom, each file would need to maintain paths relative each other file, for example:
4748
````js
48-
var
49-
loginForm = require('../../framework/views/login.js')
50-
, signupForm = require('../../framework/views/signup.js')
49+
let loginForm = require('../../framework/views/login.js');
50+
let signupForm = require('../../framework/views/signup.js');
5151

52-
, userModel = require('../../framework/models/user')
52+
let userModel = require('../../framework/models/user');
5353

54-
, normalizeUser = require('../../../utlity/normalize/user.js')
54+
let normalizeUser = require('../../../utlity/normalize/user.js');
5555
````
5656

5757

0 commit comments

Comments
 (0)