Add beta-phase info

Author: iarata

.gitignore

@@ -26,6 +26,7 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+sleep-data/
 
 # PyInstaller
 *.manifest

README.md

@@ -6,6 +6,9 @@
 
 A high-performance Python library for processing and analysing data from [CARP](https://carp.computerome.dk/) (Copenhagen Research Platform) studies.
 
+> [!BETA]
+> The CARP package is at the beta phase and the APIs and methods might change more often.
+
 ## Features
 
 - **Schema Discovery**: Automatically scans and infers the schema of the data

examples/demo.ipynb

@@ -16,9 +16,9 @@
     "from sleepiness import SleepinessData\n",
     "\n",
     "file_paths = [\n",
-    "    \"data/phase-1-1/data-streams.json\",\n",
-    "    \"data/phase-2-1/data-streams.json\",\n",
-    "    \"data/phase-3-1/data-streams.json\"\n",
+    "    \"sleep-data/phase-1-1/data-streams.json\",\n",
+    "    \"sleep-data/phase-2-1/data-streams.json\",\n",
+    "    \"sleep-data/phase-3-1/data-streams.json\"\n",
     "]\n",
     "# OR\n",
     "# file_paths = \"data/phase-1-1/data-streams.json\"\n",
@@ -482,7 +482,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "sleepiness (3.13.5)",
+   "display_name": "carp-analytics-python (3.13.5)",
    "language": "python",
    "name": "python3"
   },