From d19f4491fbc5f805e40342295c11006e0329c171 Mon Sep 17 00:00:00 2001 From: Adrian Gaudebert Date: Sat, 2 May 2020 13:15:00 +0200 Subject: [PATCH] (doc) Add a more visible link to gitter community in README. (#664) * (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 --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 33521b5a8..a6d0f864e 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,12 @@

- Full Documentation: link + Read the Documentation + +

+ +

+ boardgame.io is an engine for creating turn-based games using JavaScript.

Write simple functions that describe how the game state changes @@ -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 ``` @@ -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). @@ -58,4 +71,4 @@ to find things that you could contribute to. ## License -MIT +[MIT](LICENSE)