<NME> README.md
<BEF> # ![](https://raw.githubusercontent.com/Mindmapp/mindmapp/master/resources/icons/32x32.png) Mindmapp<sup>beta</sup>

[![](https://img.shields.io/badge/project-Mindmapp-blue.svg?style=flat-square)](https://github.com/Mindmapp)
[![](https://img.shields.io/badge/chat-Slack-orange.svg?style=flat-square)](https://join.slack.com/t/mindmapp-org/shared_invite/enQtNDE4OTUwOTQ4OTc3LWRkZDExM2E5MTJlNzZhZDBjZTFhMzVjMDhjMDFhOTY0NjBkMzMwYjRiY2FmNWNiNjRiYzdhZmNjZDE4YzkwYjk)
[![](https://img.shields.io/github/license/mindmapp/mindmapp.svg?style=flat-square)](https://github.com/Mindmapp/mindmapp/blob/dev/LICENSE.md)
[![](https://img.shields.io/david/mindmapp/mindmapp.svg?style=flat-square)](https://david-dm.org/mindmapp/mindmapp)
[![](https://img.shields.io/david/dev/mindmapp/mindmapp.svg?style=flat-square)](https://david-dm.org/mindmapp/mindmapp?type=dev)
[![](https://img.shields.io/github/downloads/mindmapp/mindmapp/total.svg?style=flat-square)](https://github.com/Mindmapp/mindmapp/releases)
[![](https://img.shields.io/travis/Mindmapp/mindmapp.svg?style=flat-square)](https://travis-ci.org/Mindmapp/mindmapp)


Mindmapp is a desktop application to draw mind maps quickly and efficiently. It was born with the intention to make the creation of mind maps extremely simple, while maintaining the fundamental properties that make the mind maps so efficient.

![Mind map](https://raw.githubusercontent.com/Mindmapp/mindmapp/master/src/assets/images/example.png)

## Development

### Clone and install dependencies

```sh
> git clone https://github.com/Mindmapp/mindmapp.git
> cd mindmapp
> npm i
```

### Run angular & electron

```sh
> npm run ng:build
> npm start
```
### Rules

#### Commits


With the following installed:
- git
- node >= 12
- npm >= 6

Clone the repo and install the dependencies from npm.

```bash
git clone https://github.com/Mindmapp/mindmapp.git
cd mindmapp
npm i
```

## :video_game: Usage

For local *development* with angular dev server:

```bash
npm start
```

Then open [http://localhost:4200](http://localhost:4200) in your browser.

If you want to generate the project documentation:

```bash
npm run doc
```

A `documentation` folder will be generated in the project path.

## :chart_with_upwards_trend: Development

### :scroll: Rules

#### Commits

    git branch -b feat/side-bar
    git branch -b style/header

## License
* See [LICENSE](https://github.com/mindmapp/mindmapp/blob/master/LICENSE) file

## Contact
#### Developer
* e-mail : omardesogus9@gmail.com
* github : [@cedoor](https://github.com/cedoor)
* website : https://cedoor.github.io
* No CamelCase.
* Use grouping tokens (words) at the beginning of your branch names (in a similar way to the `type` of commit).
* Define and use short lead tokens to differentiate branches in a way that is meaningful to your workflow.
* Use slashes to separate parts of your branch names.
* Remove branch after merge if it is not important.

Examples:
    
    git branch -b docs/README
    git branch -b test/one-function
    git branch -b feat/side-bar
    git branch -b style/header

## :raised_hand: Contributors

Mindmapp is a work in progress. Remember that if you want you can make a small contribution with a pull request.

### :computer: Code Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
<a href="https://github.com/Mindmapp/mindmapp/graphs/contributors"><img src="https://opencollective.com/mindmapp/contributors.svg?width=890&button=false" /></a>

### :moneybag: Financial Contributors

Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/mindmapp/contribute)]

#### Individuals

<a href="https://opencollective.com/mindmapp"><img src="https://opencollective.com/mindmapp/individuals.svg?width=890"></a>

#### Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/mindmapp/contribute)]

<a href="https://opencollective.com/mindmapp/organization/0/website"><img src="https://opencollective.com/mindmapp/organization/0/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/1/website"><img src="https://opencollective.com/mindmapp/organization/1/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/2/website"><img src="https://opencollective.com/mindmapp/organization/2/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/3/website"><img src="https://opencollective.com/mindmapp/organization/3/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/4/website"><img src="https://opencollective.com/mindmapp/organization/4/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/5/website"><img src="https://opencollective.com/mindmapp/organization/5/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/6/website"><img src="https://opencollective.com/mindmapp/organization/6/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/7/website"><img src="https://opencollective.com/mindmapp/organization/7/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/8/website"><img src="https://opencollective.com/mindmapp/organization/8/avatar.svg"></a>
<a href="https://opencollective.com/mindmapp/organization/9/website"><img src="https://opencollective.com/mindmapp/organization/9/avatar.svg"></a>

## :page_facing_up: License
* See [LICENSE](https://github.com/cedoor/ceditor/blob/master/LICENSE) file.

## :telephone_receiver: Contacts
### :boy: Developers
* e-mail : me@cedoor.dev
* github : [@cedoor](https://github.com/cedoor)
* website : https://cedoor.dev

<MSG> [docs] update README
<DFF> @@ -1,35 +1,75 @@
-# ![](https://raw.githubusercontent.com/Mindmapp/mindmapp/master/resources/icons/32x32.png) Mindmapp<sup>beta</sup>
-
-[![](https://img.shields.io/badge/project-Mindmapp-blue.svg?style=flat-square)](https://github.com/Mindmapp)
-[![](https://img.shields.io/badge/chat-Slack-orange.svg?style=flat-square)](https://join.slack.com/t/mindmapp-org/shared_invite/enQtNDE4OTUwOTQ4OTc3LWRkZDExM2E5MTJlNzZhZDBjZTFhMzVjMDhjMDFhOTY0NjBkMzMwYjRiY2FmNWNiNjRiYzdhZmNjZDE4YzkwYjk)
-[![](https://img.shields.io/github/license/mindmapp/mindmapp.svg?style=flat-square)](https://github.com/Mindmapp/mindmapp/blob/dev/LICENSE.md)
-[![](https://img.shields.io/david/mindmapp/mindmapp.svg?style=flat-square)](https://david-dm.org/mindmapp/mindmapp)
-[![](https://img.shields.io/david/dev/mindmapp/mindmapp.svg?style=flat-square)](https://david-dm.org/mindmapp/mindmapp?type=dev)
-[![](https://img.shields.io/github/downloads/mindmapp/mindmapp/total.svg?style=flat-square)](https://github.com/Mindmapp/mindmapp/releases)
-[![](https://img.shields.io/travis/Mindmapp/mindmapp.svg?style=flat-square)](https://travis-ci.org/Mindmapp/mindmapp)
+[![mindmapp-illustration](https://raw.githubusercontent.com/Mindmapp/mindmapp/dev/src/assets/images/readme-header.png)][mindmapp-website-url]
+
+<p align="center">
+    <h1 align="center">
+        <img width="40" src="https://raw.githubusercontent.com/Mindmapp/mindmapp/dev/src/assets/icons/icon-72x72.png">
+        Mindmapp
+    </h1>
+    <p align="center">Web application to draw mind maps.</p>
+</p>
+    
+[![mindmapp-project][mindmapp-project]][mindmapp-project-url]
+[![slack][slack]][slack-url]
+[![license][license]][license-url]
+[![dependencies][dependencies]][dependencies-url]
+[![dev-dependencies][dev-dependencies]][dev-dependencies-url]
+
+___
+
+## :paperclip: Table of Contents
+- :rocket: [Features](#rocket-features)
+- :hammer: [Install](#hammer-install)
+- :video_game: [Usage](#video_game-usage)
+- :chart_with_upwards_trend: [Development](#chart_with_upwards_trend-development)
+  - :raised_hand: [Contribute](#raised_hand-contribute)
+  - :scroll: [Rules](#scroll-rules)
+    - [Commits](#commits)
+    - [Branches](#branches)
+- :page_facing_up: [License](#page_facing_up-license)
+- :telephone_receiver: [Contacts](#telephone_receiver-contacts)
+  - :boy: [Developers](#boy-developers)
+
+## :rocket: Features
+
+- :heavy_check_mark: Local storage
+- :heavy_check_mark: JSON export
+- :heavy_check_mark: Image export
+- :heavy_check_mark: PDF export
+- :heavy_check_mark: PWA support
+- :x: Distributed database
+
+## :hammer: Install
+
+With the following installed:
+- git
+- node >= 12
+- npm >= 6
+
+Clone the repo and install the dependencies from npm.
+
+```bash
+git clone https://github.com/Mindmapp/mindmapp.git
+cd mindmapp
+npm i
+```
 
+## :video_game: Usage
 
-Mindmapp is a desktop application to draw mind maps quickly and efficiently. It was born with the intention to make the creation of mind maps extremely simple, while maintaining the fundamental properties that make the mind maps so efficient.
+For local *development* with angular dev server:
 
-![Mind map](https://raw.githubusercontent.com/Mindmapp/mindmapp/master/src/assets/images/example.png)
+```bash
+npm start
+```
 
-## Development
+Then open [http://localhost:4200](http://localhost:4200) in your browser.
 
-### Clone and install dependencies
+## :chart_with_upwards_trend: Development
 
-```sh
-> git clone https://github.com/Mindmapp/mindmapp.git
-> cd mindmapp
-> npm i
-```
+### :raised_hand: Contribute
 
-### Run angular & electron
+Mindmapp is a work in progress. Remember that if you want you can make a small contribution with a pull request.
 
-```sh
-> npm run ng:build
-> npm start
-```
-### Rules
+### :scroll: Rules
 
 #### Commits
 
@@ -74,11 +114,28 @@ Examples:
     git branch -b feat/side-bar
     git branch -b style/header
 
-## License
-* See [LICENSE](https://github.com/mindmapp/mindmapp/blob/master/LICENSE) file
+## :page_facing_up: License
+* See [LICENSE](https://github.com/cedoor/ceditor/blob/master/LICENSE) file.
 
-## Contact
-#### Developer
+## :telephone_receiver: Contacts
+### :boy: Developers
 * e-mail : omardesogus9@gmail.com
 * github : [@cedoor](https://github.com/cedoor)
-* website : https://cedoor.github.io
+* website : https://cedoor.org
+
+[mindmapp-website-url]: https://mindmapp.cedoor.org
+
+[mindmapp-project]: https://img.shields.io/badge/project-Mindmapp-blue.svg?style=flat-square
+[mindmapp-project-url]: https://travis-ci.org/hamedbaatour/angularfire-lite
+
+[slack]: https://img.shields.io/badge/chat-Slack-orange.svg?style=flat-square
+[slack-url]: https://join.slack.com/t/mindmapp-org/shared_invite/enQtNDE4OTUwOTQ4OTc3LWRkZDExM2E5MTJlNzZhZDBjZTFhMzVjMDhjMDFhOTY0NjBkMzMwYjRiY2FmNWNiNjRiYzdhZmNjZDE4YzkwYjk
+
+[license]: https://img.shields.io/github/license/mindmapp/mindmapp.svg?style=flat-square
+[license-url]: https://github.com/Mindmapp/mindmapp/blob/master/LICENSE
+
+[dependencies]: https://img.shields.io/david/mindmapp/mindmapp.svg?style=flat-square
+[dependencies-url]: https://david-dm.org/mindmapp/mindmapp
+
+[dev-dependencies]: https://img.shields.io/david/dev/mindmapp/mindmapp.svg?style=flat-square
+[dev-dependencies-url]: https://david-dm.org/mindmapp/mindmapp?type=dev

[docs] update README