Merge 1178472 into 426e312

CONTRIBUTING.md

@@ -1,49 +1,38 @@
-
-## Contributing ##  
+## Contributing 
 
 Please read this doc before start to use this repo. We have a set of guidelines that should be followed.  
 
 Feel free to propose changes to this document using a pull request.  
 
 * Code patterns  
 
-### Available Scripts ###  
-
-Local Development enviroment  
-```  
-npm start (component-name)
-```  
-Build for production  
-```  
-npm run build  
-```  
-Run unit testing  
-```  
-npm test  
-```  
+### Available Scripts
+
+See [README](./README.md#available-scripts).
 
-### Git Workflow ###  
+### Git Workflow
 
 We use [GitFlow](http://nvie.com/posts/a-successful-git-branching-model/).  
 
-### Branching  
+### Branching
+
 - ```feature/feature-name``` to new features.  
 - ```fix/bug-name``` to fix bugs.  
 - ```improvement/improvement-name``` to improvement code.  
 
-### Commit messages ###  
+### Commit messages
 
 - Feel free to commit clear messages, in **english** to describe every single change in your branch.  
 - We use [conventional commits](https://conventionalcommits.org/) as guidelines for merge commits.
 
-### Pull Requests ###  
+### Pull Requests
 
 All Pull Request must be made to the `develop branch`.  
 
 Before opening a Pull Request, verify if all tests ppassesassed,   
 we have CI tools to run tests, if it fails [you will be notified](https://www.youtube.com/watch?v=mmLRTVYgEq4).  
 
 
-### Releasing a new version ###
+### Releasing a new version
 
 Open a PR to the develop and master branchs.

README.md

@@ -1,16 +1,27 @@
 # Sling Web  
 [![Build Status](https://travis-ci.org/stone-payments/sling-web-framework.svg?branch=master)](https://travis-ci.org/stone-payments/sling-web-framework) [![Coverage Status](https://coveralls.io/repos/github/stone-payments/sling-web-framework/badge.svg?branch=task%2FCMPDC-909)](https://coveralls.io/github/stone-payments/sling-web-framework?branch=task%2FCMPDC-909)
 
-## Technologies  
-  - [Lerna](https://lernajs.io/)
-  - [Karma](https://karma-runner.github.io/2.0/index.html)
+## Technologies
+  - [Babel](https://babeljs.io/)
+  - [Chai](https://www.chaijs.com/)
   - [EsLint](https://eslint.org/), rules extends [eslint-config-airbnb](https://www.npmjs.com/package/eslint-config-airbnb)
+  - [Karma](https://karma-runner.github.io)
+  - [Lerna](https://lernajs.io/)
+  - [Mocha](https://mochajs.org/)
   - [RollUp](https://rollupjs.org/guide/en)
+  - [Sinon](https://sinonjs.org/)
+  - [TestCafé](http://devexpress.github.io/testcafe/)
+  - [Webpack](https://webpack.js.org/)
 
 ## Usage  
 
 #### Node
-v8.10.0
+v8.x.x >= v8.9.0
+
+#### Npm
+v6.x.x >= v6.4.0
+
+## Available scripts
 
 #### Install
 `npm install`
@@ -36,16 +47,18 @@ Runs tests that depend on the DOM using Chrome. If a component name is passed as
 
 Runs tests that do not depend on the DOM using Mocha and generates a coverage report. If a component name is passed as parameter, the tests will run for that specific component but the coverage report will not be generated.
 
-#### Server  
-`npm run server`
-
-Starts a static server at the root of the project, allowing one to navigate through the generated components. It is possible, for example, to visit the public folders of all basic components. To visit the Button component, the URL would be http://127.0.0.1:8080/packages/sling-web-component-button/public/.
-
-By appending `?es=6` or `?es=5` to the end of URL, one can choose which version of the component to preview, which can be either ES5 ou ES6.
-
 #### Build  
 `npm run build` or `npm run build component-name`
 
 Generates the distribution folders of all components. If a component name is passed as parameter, it only generates the distribution folder for that specific component.
 
+#### Server  
+`npm run server` or `npm run server component-name`
+
+Starts a static server, allowing you to navigate through stand-alone, browser-specific versions of all components. If a component name is passed as parameter, the server will open on that component's folder, otherwise, it will open on the project's root folder.
+
+Note that this command depends on `npm run build` to be run first, in order to generate the components' distribution files.
+
+By appending `?es=6` or `?es=5` to the end of URL, you can choose which EcmaScript version is used by the component (either 5 or 6 are allowed).
+
 ## [Contribute](./CONTRIBUTING.md)