diff --git a/README.md b/README.md index 60e4b9f3..e13b9f6b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [brm.io/matter-js](http://brm.io/matter-js) -[Features](#features) - [Status](#status) - [Install](#install) - [Usage](#usage) - [Docs](http://brm.io/matter-js-docs/) - [Implementation](#implementation) - [References](#references) - [License](#license) +[Features](#features) - [Install](#install) - [Usage](#usage) - [Docs](http://brm.io/matter-js-docs/) - [Implementation](#implementation) - [References](#references) - [License](#license) [![Build Status](https://travis-ci.org/liabru/matter-js.png?branch=master)](https://travis-ci.org/liabru/matter-js) @@ -14,41 +14,50 @@
@@ -57,18 +66,20 @@ ### Features +- Rigid bodies +- Compound bodies +- Composite bodies +- Concave and convex hulls - Physical properties (mass, area, density etc.) -- Rigid bodies of any convex polygon -- Stable stacking and resting -- Collisions (broad-phase, mid-phase and narrow-phase) - Restitution (elastic and inelastic collisions) +- Collisions (broad-phase, mid-phase and narrow-phase) +- Stable stacking and resting - Conservation of momentum - Friction and resistance +- Events - Constraints - Gravity -- Composite bodies - Sleeping and static bodies -- Events - Rounded corners (chamfering) - Views (translate, zoom) - Collision queries (raycasting, region tests) @@ -96,21 +107,16 @@ 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.
+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. +Check out the [demo page](http://brm.io/matter-js-demo-master/) 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 -Edge build documentation is at [Matter.js 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/) -### Status - -Matter.js is currently in *alpha* status, meaning the API is still in development and may change occasionally.
-The library is reasonably stable as-is, but it is not yet feature complete. - ### Building and Contributing To build you must first install [node.js](http://nodejs.org/) and [gulp](http://gulpjs.com/), then run @@ -133,8 +139,7 @@ To see what's new or changed in the latest version, see the [changelog](https:// ### Implementation -The technical details for physics nerds and game devs. -
This engine is using the following techniques: +The engine uses the following techniques: - Time-corrected position Verlet integrator - Adaptive grid broad-phase detection @@ -158,8 +163,8 @@ See my post on [Game physics for beginners](http://brm.io/game-physics-for-begin ### License -Matter.js is licensed under [The MIT License (MIT)](http://opensource.org/licenses/MIT) -
Copyright (c) 2014 Liam Brummitt +Matter.js is licensed under [The MIT License (MIT)](http://opensource.org/licenses/MIT) +Copyright (c) 2014 Liam Brummitt -This license is also supplied with the release and source code. -
As stated in the license, absolutely no warranty is provided. \ No newline at end of file +This license is also supplied with the release and source code. +As stated in the license, absolutely no warranty is provided.