Query results

README.md

@@ -1,7 +1,7 @@
 # Flecs Explorer
 Web-based UI for monitoring Flecs applications, trying out queries & learning ECS
 
-<img width="995" alt="Screen Shot 2021-11-07 at 10 20 51 PM" src="https://user-images.githubusercontent.com/9919222/140693729-12b9c7bb-3147-4040-9c15-d830e9bc1080.png">
+<img width="1038" alt="Screen Shot 2022-06-01 at 3 42 48 PM" src="https://user-images.githubusercontent.com/9919222/171513654-894549df-8ad5-4d39-a82a-d57e425ece9e.png">
 
 A live version of the explorer is running @ https://flecs.dev/explorer
 
@@ -72,6 +72,35 @@ docker run --name=explorer -p 80:80 --restart=unless-stopped -d sandermertens/fl
 
 You can now go to http://localhost to open the explorer.
 
+### Statistics
+The explorer can visualize statistics from Flecs applications. Statistics collection is disabled by default as it is not free. To enable it, import the `flecs.monitor` module:
+
+In C:
+```c
+ECS_IMPORT(world, FlecsMonitor);
+```
+
+In C++:
+```c
+world.import<flecs::monitor>();
+```
+
+Note that the statistics collection systems run as part of the default Flecs pipeline. If your application does not use systems, manually runs systems or uses a custom pipeline statistics collection will not run. To make sure the collection systems are ran, call this once in the main loop of your game:
+
+In C:
+```c
+ecs_progress(world, 0);
+```
+
+In C++
+```c
+world.progress();
+```
+
+You should now be able to see statistics in the explorer, which should look like this:
+
+<img width="1231" alt="Screen Shot 2022-06-04 at 1 14 49 AM" src="https://user-images.githubusercontent.com/9919222/171993359-d3d31208-6e7e-46ad-909e-c5f80fa492d3.png">
+
 ### URL options
 The following options can be added to the URL: