Improve Readme #262
Merged
Improve Readme #262
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
megatroom
suggested changes
Mar 24, 2020
|
|
||
|
|
||
| ## 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. |
There was a problem hiding this comment.
We could put a badge at the beginning to indicate Slack, many people will not even get here at the end, and it also avoids an extra topic. What do you think?
| Some questions come up over and over again. Check here first: | ||
| [FAQ](docs/faq.md) | ||
|
|
||
| ## Get in Touch |
There was a problem hiding this comment.
Here you don't give the title space, in the previous title you give it. Use the vscode markdown plugin and have the file formatted.
| @@ -7,7 +7,7 @@ | |||
| <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> | |||
| </p> | |||
|
|
|||
| ## Welcome to the **#matrix** | |||
| # Welcome to **#matrix** | |||
There was a problem hiding this comment.
There's "the", an example: https://www.youtube.com/watch?v=QdurBIvrIWg
And the ideal even if it is two "#" because the main topic is the first line
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Update README to a better usability.
How to test?
Just read.
Expected behavior
No English typos and full understanding from the readme