api doc

Author: TTangNingzhi

.idea/workspace.xml

@@ -21,6 +21,10 @@ The data collected by CodeGRITS can be used by empirical SE researchers to under
 especially those related to eye gaze. CodeGRITS also provides a [real-time data API](developer.md)
 for future plugin developers and researchers to design context-aware programming support tools.
 
+We provide an example project [DataStreamReceiver](https://github.com/codegrits/DataStreamReceiver) that builds on top
+of the real-time data API. It is designed to receive the IDE and eye tracking data and directly visualize them in two
+separate windows.
+
 ## Key Features
 
 - :mag: **IDE Tracking**: CodeGRITS tracks developers’ IDE interactions, including mouse clicks, keyboard inputs, etc.

README.md

@@ -38,12 +38,11 @@ We provide a real-time data API for future JetBrains plugin developers and resea
 IDE tracker and eye tracker separately. The API is based on the [IDE Tracker](#ide-tracker)
 and [Eye Tracker](#eye-tracker).
 
-#### Example Project
-
+!!! Example Project
 We provide an example project [DataStreamReceiver](https://github.com/codegrits/DataStreamReceiver)
-that builds on top of the real-time data API. It is designed to receive real-time IDE tracking and eye tracking data and
-directly visualize them in two separate windows. You could refer to the source code of the example project to learn how
-to use the API.
+that builds on top of the real-time data API. It is designed to receive the IDE and eye tracking data and directly 
+visualize them in two separate windows. You could refer to its source code to learn how to use the API.
+!!!
 
 ### Configuration
 
@@ -62,7 +61,6 @@ intellij {
 You also need to add the following to `./src/main/resources/META-INF/plugin.xml`.
 
 ```xml
-
 <depends>com.nd.codegrits</depends>
 ```
 
@@ -74,13 +72,13 @@ the `ideTrackerDataHandler` or `eyeTrackerDataHandler` to handle the real-time d
 method to start tracking.
 
 ```java
-IDETracker ideTracker=IDETracker.getInstance();
-        ideTracker.setIsRealTimeDataTransmitting(true);
-        ideTracker.setIdeTrackerDataHandler(element->{
-        String formattedStr="Event: "+element.getAttribute("id");
-        System.out.println(formattedStr);
-        });
-        ideTracker.startTracking(currentProject);
+IDETracker ideTracker = IDETracker.getInstance();
+ideTracker.setIsRealTimeDataTransmitting(true);
+ideTracker.setIdeTrackerDataHandler(element -> {
+    String formattedStr = "Event: " + element.getAttribute("id");
+    System.out.println(formattedStr);
+});
+ideTracker.startTracking(currentProject);
 ```
 
 !!!