From 64fdccc85ac7ad3632538b8b2c56b1da9c7de918 Mon Sep 17 00:00:00 2001
From: yuko1101 <68993883+yuko1101@users.noreply.github.com>
Date: Sun, 7 May 2023 19:30:43 +0900
Subject: [PATCH] Update README.md
---
README.md | 146 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 146 insertions(+)
diff --git a/README.md b/README.md
index cf6abc2..41a8af1 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,148 @@
# starrail.js
+
+
+# StarRail.js
+
+
+
+
+
+
+
+## About
+
A Node.js library for Star Rail.
+
+### Features
+- All Characters and All Light Cones Data.
+- Cache Updater for the new update of Honkai: Star Rail. (Update characters and light cones immediately.)
+
+
+## Installation
+
+**Node.js 16 or newer is required.**
+
+Install starrail.js including Star Rail cache data.
+```sh-session
+npm install starrail.js
+```
+
+ Install using ghproxy.com
+
+ npm install starrail.js --sr-ghproxy=true
+
+
+
+If you have already moved the cache to another folder, you can also install without downloading the cache.
+```sh-session
+npm install starrail.js --sr-nocache=true
+```
+
+## About Star Rail Cache Data
+Star Rail cache data is from [Dimbreath/StarRailData](https://github.com/Dimbreath/StarRailData)
+
+This data contains data of characters, light cones, materials, and more structure information of Star Rail.
+
+You can change your cache directory.
+```js
+const { StarRail } = require("starrail.js");
+
+// Change the directory to store cache data.
+// Default directory is **/starrail.js/cache.
+// Re-fetching contents may be required, if you update
+// starrail.js with the cache directory in it.
+const client = new StarRail();
+client.cachedAssetsManager.cacheDirectoryPath = "./cache";
+client.cachedAssetsManager.cacheDirectorySetup();
+
+// OR
+
+const client = new StarRail({ cacheDirectory: "./cache" });
+client.cachedAssetsManager.cacheDirectorySetup();
+
+```
+
+### Updating
+
+You can update your Star Rail cache data.
+```js
+const { StarRail } = require("starrail.js");
+const client = new StarRail({ showFetchCacheLog: true }); // showFetchCacheLog is true by default
+
+client.cachedAssetsManager.fetchAllContents(); // returns promise
+```
+
+
+Also, you can activate auto cache updater.
+
+When using the auto-cache updater, we strongly recommend moving the cache directory directly under your project folder. (**DO NOT delete \*\*/starrail.js/cache when moving directory, just delete all folders/files in it.**)
+
+```js
+const { StarRail } = require("starrail.js");
+const client = new StarRail();
+
+client.cachedAssetsManager.activateAutoCacheUpdater({
+ instant: true, // Run the first update check immediately
+ timeout: 60 * 60 * 1000, // 1 hour interval
+ onUpdateStart: async () => {
+ console.log("Updating Star Rail Data...");
+ },
+ onUpdateEnd: async () => {
+ client.cachedAssetsManager.refreshAllData(); // Refresh memory
+ console.log("Updating Completed!");
+ }
+});
+
+// // deactivate
+// client.cachedAssetsManager.deactivateAutoCacheUpdater();
+```
+
+# How to use
+
+## Star Rail Character List
+[StarRail#getAllCharacters](https://enka-network-api.vercel.app/docs/api/StarRail#getAllCharacters)
+```js
+const { StarRail } = require("starrail.js");
+const client = new StarRail();
+
+const characters = client.getAllCharacters();
+// print character names with language "en"
+console.log(characters.map(c => c.name.get("en")));
+```
+
+## Star Rail Light Cone List
+[StarRail#getAllLightCones](https://enka-network-api.vercel.app/docs/api/StarRail#getAllLightCones)
+```js
+const { StarRail } = require("starrail.js");
+const client = new StarRail();
+
+const lightCones = client.getAllLightCones();
+// print light cone names with language "jp"
+console.log(lightCones.map(w => w.name.get("jp")));
+```
+
+More examples are available in [example](https://github.com/yuko1101/starrail.js/tree/main/example) folder.
+
+For more information, please check [Documentation](https://enka-network-api.vercel.app/docs/api/StarRail).
+
+You can see the changelog [here](https://github.com/yuko1101/starrail.js/blob/main/CHANGELOG.md).
\ No newline at end of file
+ 
+ 
+ 
+