Rewriting FA2 documentation

Yomguithereal · Yomguithereal · commit 971b9d6ac226 · 2014-05-21T17:23:53.000+02:00
diff --git a/plugins/sigma.layout.forceAtlas2/README.md b/plugins/sigma.layout.forceAtlas2/README.md
@@ -1,12 +1,56 @@
 sigma.layout.forceAtlas2
 ========================
 
-Plugin developed by [Mathieu Jacomy](https://github.com/jacomyma).
+Algorithm by [Mathieu Jacomy](https://github.com/jacomyma).
+Plugin by [Guillaume Plique](https://github.com/Yomguithereal).
 
 ---
 
-This plugin adds two methods to every sigma instances, `startForceAtlas2` and `stopForceAtlas2`. It implements [ForceAtlas2](http://webatlas.fr/tempshare/ForceAtlas2_Paper.pdf), a force-directed layout algorithm.
+This plugin implements [ForceAtlas2](http://www.medialab.sciences-po.fr/publications/Jacomy_Heymann_Venturini-Force_Atlas2.pdf), a force-directed layout algorithm.
 
-Basically, `myInstance.startForceAtlas2()` will start running the layout: It will spawn an atomic job in [conrad](http://jacomyal.github.io/conrad.js/) that will compute the next step. When the job is done, the `refresh` method of the instance will be called, and everything starts again.
+For optimization purposes, the algorithm's computations are delegated to a web worker.
 
-The layout will not stop by itself, and it is necessary to call `myInstance.stopForceAtlas2()`.
+## Methods
+
+**sigma.startForceAtlas2**
+Start or unpause the layout. It is possible to pass a configuration if this is the first time you start the layout.
+
+```js
+sigmaInstance.startForceAtlas2(config);
+```
+
+**sigma.stopForceAtlas2**
+Pause the layout.
+
+```js
+sigmaInstance.stopForceAtlas2();
+```
+
+**sigma.configForceAtlas2**
+Change the layout's configuration after this one has started or is paused.
+
+```js
+sigmaInstance.configForceAtlas2(config);
+```
+
+**sigma.killForceAtlas2**
+Completely stop the layout and terminate the assiociated worker. You can still restart it later, but a new worker will have to initialize.
+
+```js
+sigmaInstance.killForceAtlas2();
+```
+
+## Configuration
+
+* **linLogMode**: *boolean* `false`
+* **outboundAttractionDistribution** *boolean* `false`
+* **adjustSizes** *boolean* `false`
+* **edgeWeightInfluence** *number* `0`
+* **scalingRatio** *number* `1`
+* **strongGravityMode** *boolean* `false`
+* **gravity** *number* `1`
+
+## Notes
+1. *Barnes-Hut* optimizations are disabled for the time being. We need time to develop a low-level version of the optimization in order to scale efficiently.
+
+2. The layout won't stop by itself, so I you want it to stop, you have to trigger it explicitely.
