From 84e2ae5cf8b3557d48f1d4035f78c5feedbc2d4c Mon Sep 17 00:00:00 2001
From: MaxOhn <ohn.m@hotmail.de>
Date: Fri, 12 Jul 2024 10:31:04 +0200
Subject: [PATCH] readme adjustments

---
 README.md | 22 ++++++++++++++++++----
 1 file changed, 18 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index d44b385..9f64072 100644
--- a/README.md
+++ b/README.md
@@ -49,8 +49,20 @@ The constructor takes [an *optional* object of the form](https://github.com/MaxO
 
 ```ts
 {
-    // Mod bitflags, see <https://github.com/ppy/osu-api/wiki#mods>
-    mods?: number,
+    // The type must be either
+    //   - an integer for bitflags (see https://github.com/ppy/osu-api/wiki#mods)
+    //   - a string for acronyms
+    //   - a single mod object as described below
+    //   - a sequence of types that deserialize into a single mod
+    //
+    // Types that deserialize into a single mod are
+    //   - an integer for bitflags
+    //   - a string for an acronym
+    //   - a mod object
+    //
+    // A mod object must have an `acronym: string` property and an optional
+    // `settings?: Object` property.
+    mods?: Object,
     // Custom clock rate between 0.01 and 100
     clockRate?: number,
     // Custom approach rate between -20 and 20
@@ -168,7 +180,7 @@ Its constructor takes [an object of the form](https://github.com/MaxOhn/rosu-pp-
     mode?: GameMode,
     // Whether the map is a convert, only relevant for mania
     isConvert?: boolean,
-    mods?: number,
+    mods?: Object,
     clockRate?: number,
     ar?: number,
     arWithMods?: boolean,
@@ -224,7 +236,7 @@ const maxAttrs = new rosu.Performance({ mods: 8 + 64 }).calculate(map);
 
 // Calculating performance attributes for a specific score.
 const currAttrs = new rosu.Performance({
-    mods: 8 + 64, // Must be the same as before in order to use the previous attributes!
+    mods: "HDDT", // Must be the same as before in order to use the previous attributes!
     misses: 2,
     accuracy: 98.4,
     combo: 567,
@@ -297,6 +309,8 @@ or
 $ npm install https://github.com/MaxOhn/rosu-pp-js/releases/download/v1.0.2/rosu_pp_js_nodejs.tar.gz
 ```
 
+Note that apart from the `*_nodejs` version, the release page also includes `*_web` and `*_bundler` versions.
+
 ## Learn More
 - [rosu-pp]
 - [Rust]