Merge pull request #14 from jashgala/jashgala/remove-gulp-readme-script

Remove script for auto-generating Readme contents

Author: clarkerican

CONTRIBUTING.md

@@ -14,7 +14,6 @@ browsers. Keep this in mind, when modifying and/or extending the sources.
 ## Automation
 
 * The project is being built by [gulp](http://gulpjs.com/) (see [gulpfile](build/gulpfile.js)), destination directory is [build/build](build/build)
-* The documentation is auto-generated, based on [build/src](build/src) markdown sources. If you modify the main [Readme.md](Readme.md) file, the Pull Request will be rejected, since it will be overwritten by the upcoming `gulp` execution
 * The tests are executing `mocha` against all js contents of [test](test) directory
 
 ## Architecture

Readme.md

@@ -416,11 +416,3 @@ npm run browser
 ```shell
 npm run jsdoc
 ```
-
-### Building ReadMe
-
-The `ReadMe.md` file for `faker.js` is automatically generated and should not be modified directly. All updates to `ReadMe.md` should be performed in `./build/src/docs.md` and then the build script should be run.
-
-```shell
-npm run readme
-```

build/gulp-tasks/readme.js

@@ -1,12 +1,11 @@
 function defaultTask(cb) {
   // place code for your default task here
   console.log('please run gulp --tasks to see available tasks for faker.js')
-  console.log('you can then try running a command like `gulp readme`')
+  console.log('you can then try running a command like `gulp jsdoc`')
   cb();
 }
 
 exports.browser = require('./build/gulp-tasks/browser');
 exports.jsdoc = require('./build/gulp-tasks/jsdoc');
-exports.readme = require('./build/gulp-tasks/readme');
 
 exports.default = defaultTask

build/src/docs.md

@@ -10,7 +10,6 @@
   "scripts": {
     "browser": "./node_modules/.bin/gulp browser",
     "jsdoc": "./node_modules/.bin/gulp jsdoc",
-    "readme": "./node_modules/.bin/gulp readme",
     "lint": "node_modules/.bin/jshint ./lib --config ./.jshintrc",
     "test": "node_modules/.bin/mocha test/*.*.js",
     "coverage": "nyc report --reporter=text-lcov | coveralls"
@@ -65,6 +64,5 @@
   },
   "license": "MIT",
   "main": "index.js",
-  "types": "index.d.ts",
-  "dependencies": {}
+  "types": "index.d.ts"
 }