Merge pull request #398 from BeAPI/docs/update-readme

docs (README): update readme

Author: ptesei

.github/banner-github.png

@@ -1,31 +1,17 @@
+# Be API FrontEnd Framework
+
 [![Be API Github Banner](.github/banner-github.png)](https://beapi.fr)
 
-#  BeAPI FrontEnd Framework
 [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
-![Node.js CI](https://github.com/BeAPI/beapi-frontend-framework/workflows/Node.js%20CI/badge.svg?branch=master)
-
-## ℹ️ What is Be API Frontend Framework ?
-
-**Be API Frontend Framework** (BFF) is a friendly Front-end WordPress theme boilerplate to help you to start your own WordPress theme with modern tools.
 
-## ⚒️ Main tools
-* [Webpack 5](https://webpack.js.org/) JS, CSS and assets are built with Webpack.
-* [Esbuild Loader](https://github.com/privatenumber/esbuild-loader) for ESNext & TypeScript transpilation.
-* [Eslint](https://eslint.org/) for JS code style.
-* [Stylelint](https://stylelint.io/) for CSS code style.
-* [CSSNano](https://cssnano.co/) for CSS optimization
-* [PostCSS Preset Env](https://github.com/csstools/postcss-preset-env) for modern CSS properties compatibility.
-* [PostCSS PX to REM](https://github.com/cuth/postcss-pxtorem) to automatically convert px units to rem.
-* [PostCSS Sort Media Queries](https://github.com/solversgroup/postcss-sort-media-queries) to combine multiple similar medie queries declarations.
-* [SVGO](svgo-loader) for SVG optimization.
-* [Image Webpack Loader](image-webpack-loader) for images optimization.
-* [Browser Sync](https://browsersync.io/) to test your project on different devices.
+## What is BFF ?
 
+**Be API Frontend Framework** *(or BFF)*  is a WordPress theme boilerplate designed to assist you in launching your own WordPress theme using modern tools.
 
-
-## 🔴 Requirements
+## Requirements
 
 ### Composer
+
 You need composer to autoload all your classes from the inc folder.
 
 Use the `beapi/composer-scaffold-theme` package that add it automatically to the composer.json file.
@@ -40,11 +26,12 @@ You can add it yourself like this :
 ```
 
 ### Autoload
+
 The autoload is based on psr-4 and handled by composer.
 
-### Node 12+
+### Node.js
 
-You need a minimum of Node 12. Version 14 is recommended.
+You need [the latest stable version of Node.js](https://nodejs.org/).
 
 ## Installation
 
@@ -65,32 +52,32 @@ Of course, you can rename `beapi-frontend-framework` to define your WordPress th
 Next, go to your theme folder (in the following example, I didn't rename `beapi-frontend-framework`) with your favorite Term software.
 
 ```bash
-$ cd wp-content/themes/beapi-frontend-framework
+cd wp-content/themes/beapi-frontend-framework
 ```
 
 Then install node dependencies with Yarn.
+
 ```bash
-$ yarn
+yarn
 ```
+
 Alternatively, you can use NPM.
+
 ```bash
-$ npm install
+npm install
 ```
 
-## ⚙️ Configuration
+## Configuration
 
 The configurations files are in `config` directory.
+
 ### Webpack
+
 You can find the common Webpack settings file in `webpack.common.js`. For development mode purpose, you can edit `webpack.dev.js` file and for production mode, you can edit `webpack.prod.js`.
 You also have the loaders in `loaders.js` file and Webpack's plugin in `plugins.js` file.
 
-### Babel
-You can find a `.babelrc` file to modify Babel configuration.
+## How to use BFF ?
 
-### Eslint
-You can find a `.eslintrc` file to modify Eslint configuration.
-
-## 🚀 How to use BFF ?
 After installing dependencies, you can run some commands which are explained below.
 
 ### Start with Browser Sync
@@ -100,23 +87,25 @@ BFF is configured to work with [lando](https://lando.dev/). If you have a `.land
 ```js
 let fileContents = fs.readFileSync('../../../../.lando.yml', 'utf8')
 ```
-Then, run the following command from the theme :
 
+Then, run the following command from the theme :
 
 ```bash
-$ yarn start
+yarn start
 ```
+
 BrowserSync will proxy your lando'server based on the name defined in your `.lando.yml`.
+
 ### Build
 
 ```bash
-$ yarn build
+yarn build
 ```
 
 ### Bundle report
 
 You can launch a bundle report with the following command :
 
 ```bash
-$ yarn bundle-report
-```
+yarn bundle-report
+```