From 80a65a162e18a06655b2638d4e24f8b4620dba5b Mon Sep 17 00:00:00 2001
From: Konotorii <79553360+konotorii@users.noreply.github.com>
Date: Sun, 25 Feb 2024 19:55:39 -0500
Subject: [PATCH] Update README.md

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 17d6035..0dc8766 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,7 @@ This repo is meant to be up-to-date, providing type-safety and synchronous & asy
 
 
 ## Roadmap
+- - -
 
 - Write scores.db
 - Read collections.db
@@ -19,13 +20,50 @@ This repo is meant to be up-to-date, providing type-safety and synchronous & asy
 
 
 ## Features
+- - -
 
 To-Be-Completed as updates roll-out.
 
 ### Read scores.db
 ```ts
 import * as path from "path";
+import {tools} from "osu-functions";
 
-const read = await scoresRead(path.resolve('PATH TO FILE'))
+const scores = await tools.scoresRead(path.resolve('PATH TO FILE')) // returns beatmap_type[]
 /// Whatever you have to do with result...
+```
+
+
+## Types
+- - -
+### beatmap_type
+```ts
+{
+    md5: string;
+    scores: "score_type[]";
+}
+```
+### score_type
+```ts
+{
+    mode: number;
+    version: number;
+    c300: number;
+    c100: number;
+    c50: number;
+    cGeki: number;
+    cMiss: number;
+    cKatu: number;
+    replayScore: number;
+    maxCombo: number;
+    perfectCombo: number;
+    mods: number;
+    timestampWindows: string;
+    timestampMs: number;
+    onlineScoreId: string;
+    player: string;
+    beatmapMd5: string;
+    replayMd5: string;
+}
+
 ```
\ No newline at end of file