Actualiser README.md

README.md

@@ -1,3 +1,32 @@
 # uwu2x-analytics
 
-Samples for analyzing uwu2x logs
+This sample is intended to help create a script that transforms the `uwu2x` interactions into, possibly another database, in order to easily and quickly get uwu2x statistics.
+
+`uwu2x.sql` contains 7 917 rows from 2025-07-05 to 2025-10-05 (last 3 months).  
+This sample only contains 1 row per 100 real rows.
+
+There is only one table:
+```sql
+CREATE TABLE interactions (
+    id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
+    identifier VARCHAR(7) NOT NULL,
+    project VARCHAR(11) NOT NULL,
+    framerate FLOAT NOT NULL,
+    type VARCHAR(50) NOT NULL,
+    count INT DEFAULT 0,
+    date DATETIME NOT NULL,
+    version VARCHAR(10) NOT NULL
+);
+
+`type` can be:
+- "createPrecomposition" : user precomposed a clip, `count` indicates the number of clips in the created precomposition ;
+- "detectKeyframes" : user detected unique frames from clip, `count` indicates the number of detected frames ;
+- "fastAdjustment" : user created an adjustment layer ; can be ignored, only present in one version of uwu2x ;
+- "fastNull" : user created a null layer ; can be ignored, only present in one version of uwu2x ;
+- "regroupKeyframes" : user regrouped keyframes, `count` indicates the number of regrouped keyframes ;
+- "sequenceLayers" : similar to "regroupKeyframes", can be considered identical ;
+- "twixtor" : user applied Twixtor effect to a clip, `count` indicates the number of clips affected ;
+- "uwuClips" : user upscaled or interpolated clip, `count` indicates the number of clips processed.
+
+`framerate` is the framerate of the composition the user is working on.
+`version` is uwu2x version (not After Effects version).