fix: fix module entry path directory

teclone · Jul 27, 2018 · 8ee9a4c · 8ee9a4c
1 parent c46b9b4
commit 8ee9a4c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "r-server",
   "version": "0.0.0-development",
   "description": "A lightweight, extensible node.js web-server with inbuilt routing-engine, static file server, file upload handler, request body parser, middleware support and lots more",
-  "main": "index.js",
+  "main": "lib/main.js",
   "scripts": {
     "test": "BABEL_ENV=test nyc mocha --recursive",
     "watch-test": "npm run test -- -w",

diff --git a/src/main.js b/src/main.js
@@ -5,6 +5,9 @@ export default {
 
     /**
      * returns an app instance
+     *@param {string} [configPath] - an optional relative path to a user defined config file
+     * defaults to .rsvrc.json
+     *@returns {RServerApp}
     */
     instance(configPath) {
         return new RServerApp(configPath);