hop, markdown

README.md

@@ -1,32 +1,36 @@
-Blueprint Cipherbliss 
+
+![alt text][logo]
+
+Caisse | Cipherbliss 
 ====
+Self hosted Cash register and money management for your small business.
 
-A Symfony project created on March 23, 2018, 2:09 pm.
+A Symfony project created on March 23, 2018.
 
-Features:
+## Features:
-bootstrap, font awesome, user bundle
+* live selling and stock update on phone and desktop
+* managing products, categories
+* forecast of expenses
+* events
+* statistics about earnings
+* history of client purchases
+* import and export your products and selling history
+* have a look at where your expenses go during selling events
+* all in a libre software in PHP/JS
 
-install dependencies: 
+---
-```bash
+## Install
-bash install.sh
+Have a look at the [Docs to install](/docs/installation.md) your own Caisse. All documentation is in the "docs" folder.
-```
-edit parameters.yml to link to your mysql server
-
-update schema with doctrine
- ```bash
-php bin/console doctrine:schema:update --dump-sql
-php bin/console doctrine:schema:update --force
-```
-compile front end assets
-```bash
-yarn run encore dev --watch
-```
-
-access the front with your browser
-```bash
-php bin/console server:run
-firefox http://http://127.0.0.1:8000/
-```
-enjoy!
 
+Made By Tykayn/CipherBliss under [AGPL Licence](LICENSE).
+ 
 www.cipherbliss.com
+
+## Where to find help
+Join the discussion at the Matrix Channel of CipherBliss: #cipherbliss:matrix.org
+[https://matrix.to/#/!jfoYESqTObXYlKAOVM:matrix.org?via=matrix.org](matrix)
+
+
+[logo]: https://www.cipherbliss.com/wp-content/uploads/2016/12/rond.png "Logo of CipherBliss company"
+
+

docs/installation.md

@@ -0,0 +1,27 @@
+# Requirements:
+a web server speaking PHP, composer and NPM to install dependencies.
+
+
+# Installation:
+install dependencies: 
+```bash
+bash install.sh
+```
+edit parameters.yml to link to your mysql server
+
+update schema with doctrine
+ ```bash
+php bin/console doctrine:schema:update --dump-sql
+php bin/console doctrine:schema:update --force
+```
+compile front end assets
+```bash
+yarn run encore dev --watch
+```
+
+access the front with your browser
+```bash
+php bin/console server:run
+firefox http://http://127.0.0.1:8000/
+```
+enjoy!