Skip to content

Commit

Permalink
(doc) Add a more visible link to gitter community in README. (#664)
Browse files Browse the repository at this point in the history
* (doc) Add a more visible link to gitter community in README.
This also adds a few other small improvements to the README file.

Fixes #660.

* minor change

* Update README.md

Co-authored-by: Nicolo John Davis <nicolodavis@gmail.com>
  • Loading branch information
adngdb and nicolodavis committed May 2, 2020
1 parent 4b50c86 commit d19f449
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Expand Up @@ -10,7 +10,12 @@
</p>

<p align="center">
<strong>Full Documentation: <a href="https://boardgame.io/documentation/#/">link</a></strong>
<strong><a href="https://boardgame.io/documentation/#/">Read the Documentation</a></strong>

</p>

<p align="center">
<strong>boardgame.io</strong> is an engine for creating turn-based games using JavaScript.
</p>

Write simple functions that describe how the game state changes
Expand Down Expand Up @@ -39,6 +44,12 @@ networking or storage code.
$ npm install --save boardgame.io
```

### Documentation

Read our [Full Documentation](https://boardgame.io/documentation/) to learn how to
use boardgame.io, and join the [community on gitter](https://gitter.im/boardgame-io/General)
to ask your questions!

### Running examples in this repository

```
Expand All @@ -47,6 +58,8 @@ $ npm run build
$ npm start
```

The examples can be found in the [examples](examples/) folder.

## Changelog

See [changelog](docs/documentation/CHANGELOG.md).
Expand All @@ -58,4 +71,4 @@ to find things that you could contribute to.

## License

MIT
[MIT](LICENSE)

0 comments on commit d19f449

Please sign in to comment.