Skip to content

Commit 9a22015

Browse files
committed
README tweaks.
1 parent 6752072 commit 9a22015

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,21 @@ Stats.js
33

44
#### Javascript Performance Monitor ####
55

6+
67
This class provides a simple info box that will help you monitor your code performance.
78

89
* **FPS** Frames rendered in the last second. The higher the number the better.
910
* **MS** Milliseconds needed to render a frame. The lower the number the better.
1011
* **MB** MBytes of memory allocated. Make sure it doesn't keep incrementing. (Webkit-based browsers only)
1112

13+
1214
### Screenshots ###
1315

1416
![stats_js_fps.png](http://mrdoob.github.com/stats.js/assets/stats_js_fps.png)
1517
![stats_js_ms.png](http://mrdoob.github.com/stats.js/assets/stats_js_ms.png)
1618
![stats_js_mem.png](http://mrdoob.github.com/stats.js/assets/stats_js_mem.png)
1719

20+
1821
### Usage ###
1922

2023
var stats = new Stats();
@@ -32,6 +35,7 @@ This class provides a simple info box that will help you monitor your code perfo
3235

3336
}, 1000 / 60 );
3437

38+
3539
### Enable MB ###
3640

3741
* **Chrome**
@@ -42,19 +46,22 @@ This class provides a simple info box that will help you monitor your code perfo
4246
* **Safari**
4347
* MacOS: Open `~/Library/Preferences/com.apple.Safari.plist` file for editing, and add & set enabled a boolean preference *WebKitMemoryInfoEnabled* ([pic](http://mrdoob.github.com/stats.js/assets/safari_enablemem.png))
4448

49+
4550
### Bookmarklet ###
4651

4752
Albeit theorically not as accurate the widget can also be easily inserted to **any site** using the bookmarklet.
4853
[Follow the instructions](http://mrdoob.com/blog/post/707).
4954

55+
5056
### Change Log ###
5157

5258
2011 05 28 - **r6** (4.102 KB, gzip: 1.387 KB)
5359

54-
* Simply renamed MEM to MB for consistency reasons.
60+
* Updated check for memory accesible browsers.
61+
* Renamed MEM to MB for consistency reasons.
5562

5663

57-
2010 09 21 - **r5** (4.126 KB)
64+
2010 09 21 - **r5** (3.800 KB)
5865

5966
* Different color per mode.
6067
* Added MEM mode. (Webkit-based browsers only)

0 commit comments

Comments
 (0)