Added usage as class module

CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+### Added
+- usage as class module
+- docs for class usage
+
+### Removed
+- unnecessary `lib/index.js` file
+
 ## [1.2.0] - 2019-07-17
 ### Changed
 - When fails building throw an exit code.

README.md

@@ -5,7 +5,7 @@
 
 Build the exclusive files of each environment in the right config folder.
 
-## Usage
+## Usage (command line)
 
 In the console
 
@@ -20,3 +20,29 @@ npx @janiscommerce/environment-builder [ENVIRONMENT]
 
 The environments should be located in the folder `/root/environments/[ENVIRONMENT]`. It mustn't be empty.
 
+## Usage (module)
+
+```js
+const EnvironmentBuilder = require('@janiscommerce/environment-builder');
+```
+
+## API
+
+### **`new EnvironmentBuilder()`**
+Constructs the EnvironmentBuilder instance.
+
+### ***async*** **`execute(environment)`**
+Builds the environment for the specified `environment [String]`.
+
+## Examples
+```js
+const EnvironmentBuilder = require('@janiscommerce/environment-builder');
+
+const environmentBuilder = new EnvironmentBuilder();
+
+(async () => {
+
+	await environmentBuilder.execute('local');
+
+})();
+```

index.js

@@ -2,7 +2,7 @@
 
 'use strict';
 
-const { EnvironmentBuilder } = require('./lib');
+const EnvironmentBuilder = require('./lib/environment-builder');
 
 (async () => {
 	const envBuilder = new EnvironmentBuilder();

package.json

@@ -2,7 +2,7 @@
   "name": "@janiscommerce/environment-builder",
   "version": "1.2.0",
   "description": "Build the exclusive files of each environment in the right folder.",
-  "main": "index.js",
+  "main": "lib/environment-builder.js",
   "bin": {
     "environment-builder": "index.js"
   },

tests/environment-builder-test.js

@@ -10,7 +10,7 @@ const chmod = util.promisify(fs.chmod);
 
 const sandbox = require('sinon').createSandbox();
 
-const { EnvironmentBuilder } = require('./../lib');
+const EnvironmentBuilder = require('./../lib/environment-builder');
 
 describe('Exists', () => {
 	let envBuilder;