From d2dcc774bde87d4b7f1bdf6f2db1d4fee1073d61 Mon Sep 17 00:00:00 2001 From: liabru Date: Thu, 22 Jan 2015 23:13:21 +0000 Subject: [PATCH] updated readme --- README.md | 88 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 51 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 31140f1..ad2f3c8 100644 --- a/README.md +++ b/README.md @@ -10,37 +10,50 @@ ### Demos -- [Mixed Shapes](http://brm.io/matter-js-demo#mixed) -- [Solid Shapes](http://brm.io/matter-js-demo#mixedSolid) -- [Newton's Cradle](http://brm.io/matter-js-demo#newtonsCradle) -- [Wrecking Ball](http://brm.io/matter-js-demo#wreckingBall) -- [Slingshot Game](http://brm.io/matter-js-demo#slingshot) -- [Rounded Corners (Chamfering)](http://brm.io/matter-js-demo#rounded) -- [Views](http://brm.io/matter-js-demo/#views) -- [Time Scaling](http://brm.io/matter-js-demo/#timescale) -- [Raycasting](http://brm.io/matter-js-demo/#raycasting) -- [Sprites](http://brm.io/matter-js-demo/#sprites) -- [Pyramid](http://brm.io/matter-js-demo#pyramid) -- [Car](http://brm.io/matter-js-demo#car) -- [Catapult](http://brm.io/matter-js-demo#catapult) -- [Reverse Gravity](http://brm.io/matter-js-demo#gravity) -- [Bridge](http://brm.io/matter-js-demo#bridge) -- [Avalanche](http://brm.io/matter-js-demo#avalanche) -- [Basic Soft Bodies](http://brm.io/matter-js-demo#softBody) -- [Cloth](http://brm.io/matter-js-demo#cloth) -- [Events](http://brm.io/matter-js-demo/#events) -- [Chains](http://brm.io/matter-js-demo#chains) -- [Ball Pool](http://brm.io/matter-js-demo#ballPool) -- [Stack](http://brm.io/matter-js-demo#stack) -- [Circle Stack](http://brm.io/matter-js-demo#circleStack) -- [Restitution](http://brm.io/matter-js-demo#restitution) -- [Friction](http://brm.io/matter-js-demo#friction) -- [Air Friction](http://brm.io/matter-js-demo#airFriction) -- [Sleeping](http://brm.io/matter-js-demo#sleeping) -- [Grid Broadphase](http://brm.io/matter-js-demo#broadphase) -- [Beach Balls](http://brm.io/matter-js-demo#beachBalls) -- [Stress 1](http://brm.io/matter-js-demo#stress) -- [Stress 2](http://brm.io/matter-js-demo#stress2) + + + + + +
+ + + +
+
### Features @@ -70,11 +83,9 @@ ### Install -Download the [latest release](https://github.com/liabru/matter-js/releases) and include the script in your web page: +Download the [edge build (master)](https://github.com/liabru/matter-js/blob/master/build/matter.js) or get a [stable release](https://github.com/liabru/matter-js/releases) and include the script in your web page: - - -For the latest features try the [edge version (master)](https://raw.github.com/liabru/matter-js/master/build/matter.js), but it may not be fully stable. + You can also install using the package managers [Bower](http://bower.io/search/?q=matter-js) and [NPM](https://www.npmjs.org/package/matter-js). @@ -85,12 +96,15 @@ You can also install using the package managers [Bower](http://bower.io/search/? See the [Getting started](https://github.com/liabru/matter-js/wiki/Getting-started) wiki page for a minimal usage example. +Matter.js includes a sample renderer, but this is optional and it's easy to use your own.
+See the [Rendering](https://github.com/liabru/matter-js/wiki/Rendering) wiki page for information, including on how to use your own custom game loop. + Check out the [demo page](http://brm.io/matter-js-demo/) for more examples and then refer to [Demo.js](https://github.com/liabru/matter-js/blob/master/demo/js/Demo.js) to see how they work. Some of the demos are also available on [codepen](http://codepen.io/collection/Fuagy/), where you can easily experiment with them. ### Documentation -See the [Matter.js API Docs (v0.8.0)](http://brm.io/matter-js-docs/). -
If you're using the [edge version (master)](https://raw2.github.com/liabru/matter-js/master/build/matter.js) then see the [API Docs (master)](http://brm.io/matter-js-docs-master/). +Edge build documentation is at [Matter.js API Docs (master)](http://brm.io/matter-js-docs-master/)
+Stable release documentation is at [Matter.js API Docs (v0.8.0)](http://brm.io/matter-js-docs-master/) ### Status