Add more information into readme

1 files changed, 37 insertions, 6 deletions

diff --git a/README.md b/README.md
index 2589daa..c756821 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,33 @@
-# backoffice-preact
+## Merchant Admin Frontend
 
-First copy template.env into .env
-Replace evironment variables
+Merchant Admin Frontend is a Single Page Application that connect with a running Merchant Backend and lets you manage instances, order, products and tippings
 
+## System requirements
+
+- Node version: 14.15.0
+- Yarn version: 1.21.1
+
+## Environment
+
+This applications use some configuration from the environment, like the location of the Merchant Backend.
+Be sure to copy the file `template.env` into `.env` and override with your custom values.
+## Installation
+
+First run the command `yarn install` to get all the dependencies.
+The running `yarn dev` should set the server up and running.
+Use the browser to navigate into `http://localhost:8080`
 
 ## CLI Commands
+
 *   `yarn install`: Installs dependencies
 
-*   `yarn dev`: Run a development, HMR server
+*   `yarn dev`: Run a development, HMR server. The application will automatically refresh 
+     every time a file is edited
 
-*   `yarn serve`: Run a production-like server
+*   `yarn build`: Production-ready build into the `./build` directory. Print bundle size 
+     information and compare its with previous build using the `size-plugin.json` file.
 
-*   `yarn build`: Production-ready build
+*   `yarn serve`: Serves the content into `./build` directory, usefull to test the result.
 
 *   `yarn lint`: Pass TypeScript files using ESLint
 
@@ -19,4 +35,19 @@ Replace evironment variables
     [`enzyme-adapter-preact-pure`](https://github.com/preactjs/enzyme-adapter-preact-pure) for
     your tests
 
+*   `yarn storybook`: Run visual components explorer. Usefull for components design and development
+    without the need of setting up the whole system.
+
+
+## Runtime dependencies
+
+*   Axios: Promise based HTTP client for the browser and node.js
+
+*   preact: Fast 3kB alternative to React with the same modern API
+
+*   preact-router: URL component router for Preact
+
+*   SWR: React Hooks library for data fetching. (stale-while-revalidate)
+
+*   Yup: schema builder for value parsing and validation