@rian8337/osu-base 1.0.0 → 1.0.1

package/README.md

@@ -1,11 +1,68 @@
-# `osu-base`
+# About
 
-> TODO: description
+The base module required for all my osu! modules.
 
-## Usage
+# Features
 
+This module provides the required feature for all my osu! related modules, which is the beatmap parser.
+
+# Specific Requirements
+
+If you want to retrieve a beatmap using osu! API, you need to have an osu! API key set as `OSU_API_KEY` environment variable.
+
+See usage for more details.
+
+# Installation
+
+```
+npm i @rian8337/osu-base
 ```
-const osuBase = require('osu-base');
 
-// TODO: DEMONSTRATE API
+or
+
+```
+yarn add @rian8337/osu-base
+```
+
+# Usage
+
+## Using osu! API
+
+```js
+import { MapInfo } from "@rian8337/osu-base";
+
+// MD5 hash is also supported, but when both options are specified, beatmap ID is used
+const beatmapInfo = await MapInfo.getInformation({
+    beatmapID: 901854,
+    hash: "hash123",
+    file: true,
+});
+
+if (!beatmapInfo.title) {
+    return console.log("Beatmap not found");
+}
+
+// Parsed beatmap can be accessed via the `map` field
+// Note that the parsed beatmap will be cloned every time this is called. This allows caching of the original instance when needed
+console.log(beatmapInfo.map);
+```
+
+### Not retrieving beatmap file
+
+You can also opt out from downloading the beatmap (`.osu`) file if you just want to retrieve information from the API by setting `file` to `false`, however a parsed beatmap will not be provided.
+
+## Using without osu! API
+
+```js
+import { readFile } from "fs";
+import { Parser } from "@rian8337/osu-base";
+
+readFile("path/to/file.osu", { encoding: "utf-8" }, (err, data) => {
+    if (err) throw err;
+
+    const parser = new Parser().parse(data);
+
+    // Parsed beatmap can be accessed via the `map` field
+    console.log(parser.map);
+});
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rian8337/osu-base",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Base module for all osu! related modules.",
   "keywords": [
     "osu",
@@ -39,5 +39,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e4fdb9c1ed6f90e70651c1aedfdb964b61cb240d"
+  "gitHead": "8406e60764d46fc30483b95f56a097f2c0245417"
 }