Merge pull request #263 from ResultadosDigitais/docs-readme-improve

Improve docs

README.md

@@ -5,9 +5,10 @@
 <p align="center">
   <a href="https://codeclimate.com/github/ResultadosDigitais/matrix/maintainability"><img src="https://api.codeclimate.com/v1/badges/a41e6e73f69c94d8b9c5/maintainability" /></a>
   <a href="https://circleci.com/gh/ResultadosDigitais/matrix"><img alt="CircleCI Status" src="https://img.shields.io/circleci/project/github/babel/babel/master.svg?label=CircleCI&maxAge=43200"></a>
+  <a href="http://hash-matrix.slack.com/"><img alt="chat on Slack" src="https://img.shields.io/badge/Slack-chat%20with%20us-blue?logo=slack"></a>
 </p>
 
-# Welcome to **#matrix**
+## Welcome to the **#matrix**
 
 The objective of **#matrix** project is to offer a virtual environment office, as nice as physical offices. When we are working in a physical office is very common entering in discussion threads in many different environments, for example: on coffee, on lunch and others.
 
@@ -18,21 +19,24 @@ When we are working remotely there are no conversations like in a physical offic
 ![Matrix Home Screenshot](docs/img/matrix-morpheus.png)
 
 ## Table of Contents
-1. [Understanding #matrix](#Understanding-#matrix)
-   1. [Rooms](#Rooms)
-   2. [Availability And Meetings](#Availability-And-Meetings)
-2. [Installation](#Installation)
-   1. [Environment Variables](#Environment-Variables)    
-   2. [Authentication](#Authentication)       
-   3. [Docker Compose](#Docker-Compose)
-   4. [On GCP](#On-GCP)
-   5. [On Heroku](#On-Heroku)
-   6. [Production concerns](#Production-concerns)
-3. [Versions](#Versions)
-4. [Contributing](#Contributing)
-5. [Frequently Asked Questions](#Frequently-Asked-Questions)
-6. [Get in Touch](#Get-in-Touch)
-7. [License](#License)
+- [Welcome to the **#matrix**](#welcome-to-the-matrix)
+- [Table of Contents](#table-of-contents)
+- [Understanding #matrix](#understanding-matrix)
+	- [Rooms](#rooms)
+	- [Availability And Meetings](#availability-and-meetings)
+- [Installation](#installation)
+	- [Environment Variables](#environment-variables)
+		- [External Meet](#external-meet)
+	- [Authentication](#authentication)
+	- [Docker Compose](#docker-compose)
+	- [On GCP](#on-gcp)
+	- [On Heroku](#on-heroku)
+	- [Production concerns](#production-concerns)
+- [Versions](#versions)
+- [Contributing](#contributing)
+- [Frequently Asked Questions](#frequently-asked-questions)
+- [Get in Touch](#get-in-touch)
+- [License](#license)
 
 ## Understanding #matrix
 ### Rooms
@@ -146,7 +150,9 @@ If you want run the **#matrix**, you need [docker-compose](https://docs.docker.c
 
 If you prefer, you can run **#matrix** on GCP:
 
-[![Run on Google Cloud](https://deploy.cloud.run/button.svg)](https://deploy.cloud.run?git_repo=https://github.com/ResultadosDigitais/matrix&revision=gcp-deploy-button)
+<a href="https://deploy.cloud.run?git_repo=https://github.com/ResultadosDigitais/matrix&revision=gcp-deploy-button">
+<img alt="Run on Google Cloud" src="https://deploy.cloud.run/button.svg" style="max-width:200px"  />
+</a>
 
 ### On Heroku
 
@@ -181,6 +187,7 @@ Some questions come up over and over again. Check here first:
 [FAQ](docs/faq.md)
 
 ## Get in Touch
+
 There are several ways to get in touch with us:
 
 * Open an issue at: https://github.com/ResultadosDigitais/matrix/issues
@@ -191,4 +198,4 @@ There are several ways to get in touch with us:
 
 The **#matrix** is released under the [MIT License](docs/LICENSE)
 
-`"The answer is out there, Neo, and it's looking for you, and it will find you if you want it to."`
+> "The answer is out there, Neo, and it's looking for you, and it will find you if you want it to."

docs/faq.md

@@ -1,20 +1,23 @@
 # FAQs
+
 Here is a list of some frequently asked questions about **#matrix**.
 
-- [How do I ask for help?](#How-do-I-ask-for-help?)
-- [What if I find a bug?](#What-if-I-find-a-bug?)
-- [Can I request a new feature?](#Can-I-request-a-new-feature?)
-- [Does #matrix do X?](#Does-#matrix-do-X?)
-- [How do I integrate #matrix and our single-sign on (SSO) solution?](#How-do-I-integrate-#matrix-and-our-single-sign-on-(SSO)-solution?)
+- [FAQs](#faqs)
+  - [How do I ask for help?](#how-do-i-ask-for-help)
+  - [What if I find a bug?](#what-if-i-find-a-bug)
+  - [Can I request a new feature?](#can-i-request-a-new-feature)
+  - [How do I integrate #matrix and our single-sign on (SSO) solution?](#how-do-i-integrate-matrix-and-our-single-sign-on-sso-solution)
 
 
 ## How do I ask for help?
+
 You can use Stackoverflow or Slack for that. Please, do not open a support ticket in any [Resultados Digitais channel](https://resultadosdigitais.com.br/).
 
 * https://stackoverflow.com/questions/tagged/hash-matrix
 * http://hash-matrix.slack.com/ ([Invite here](https://join.slack.com/t/hash-matrix/shared_invite/zt-cwglw6te-kMlJiimq7qn4WeSTiv91og))
 
 ## What if I find a bug?
+
 If you come across something that looks like a bug, start by searching our [Github issues](https://github.com/ResultadosDigitais/matrix/issues) to see if it has already been reported. If it has, please let us know you're experiencing the same issue by reacting with a thumbs up emoji or adding a comment providing additional information.
 
 If the bug has not yet been reported, go ahead and [open a bug report](https://github.com/ResultadosDigitais/matrix/issues/new/choose). We suggest collecting the following information to help us reproduce the issue:
@@ -28,11 +31,9 @@ If the bug has not yet been reported, go ahead and [open a bug report](https://g
 7. Screenshots (if relevant)
 
 ## Can I request a new feature?
-Absolutely! New features can be added as issues in our [Github repo](ttps://github.com/ResultadosDigitais/matrix/issues). Before filing, take a minute to search and see if your feature has already been requested. If it has, it’s better to leave a thumbs up reaction on the existing issue than to file a new one. We use the thumbs up to measure how interested our community is in new features, so it’s better to have all of the thumbs ups captured on one issue.
 
-
-## Does #matrix do X?
-If you’re not sure if #matrix has the capability you’re looking for, we would recommend asking in [Slack](http://hash-matrix.slack.com/). If it’s something we don’t do, our friendly community may be able to point you towards a workaround, or the Github issue where the feature has been requested.
+Absolutely! New features can be added as issues in our [Github repo](https://github.com/ResultadosDigitais/matrix/issues). Before filing, take a minute to search and see if your feature has already been requested. If it has, it’s better to leave a thumbs up reaction on the existing issue than to file a new one. We use the thumbs up to measure how interested our community is in new features, so it’s better to have all of the thumbs ups captured on one issue.
 
 ## How do I integrate #matrix and our single-sign on (SSO) solution?
+
 Nowadays #matrix only support Google Auth, but we are working in provide other solutions (see [#229](https://github.com/ResultadosDigitais/matrix/issues/229) for more details)