- update readme

Author: GrayWolf52

README.md

@@ -1,8 +1,40 @@
-## How To Install
+<p align="left">
+  <a>
+    <img alt="Made With Unity" src="https://img.shields.io/badge/made%20with-Unity-57b9d3.svg?logo=Unity">
+  </a>
+  <a>
+    <img alt="License" src="https://img.shields.io/github/license/wolf-package/game-data-unity?logo=github">
+  </a>
+  <a>
+    <img alt="Last Commit" src="https://img.shields.io/github/last-commit/wolf-package/game-data-unity?logo=Mapbox&color=orange">
+  </a>
+  <a>
+    <img alt="Repo Size" src="https://img.shields.io/github/repo-size/wolf-package/game-data-unity?logo=VirtualBox">
+  </a>
+  <a>
+    <img alt="Last Release" src="https://img.shields.io/github/v/release/wolf-package/game-data-unity?include_prereleases&logo=Dropbox&color=yellow">
+  </a>
+</p>
 
+## What
+- System data for game unity
+- Using [Unity.Serialization](https://docs.unity3d.com/Packages/[email protected]/manual/index.html) to serialize binary data
+- Data allows you to store data in byte[] form in blocks called profiles. Each profile is a Dictionary with the key as a string and the value
+## How To Install
 ### Add the line below to `Packages/manifest.json`
 
-for version `x.x.x`
+for version `1.0.0`
 ```csharp
-"com.virtuesky._package_name_":"https://github.com/VirtueSky/_package_name_.git#x.x.x",
+"com.wolf-package.game-data":"https://github.com/wolf-package/game-data-unity.git#1.0.0",
 ```
+## Use
+
+- Initialize data when loading the game: `GameData.Init()`
+- Change Profile: `GameData.ChangeProfile(int profile)`
+- Load Data: `GameData.Load()` Load all data from file for game, data will be loaded automatically when starting the game
+- Get Data: `GameData.Get("KEY", valueDefault);` use similar to PlayerPrefs
+- Set Data: `GameData.Set("KEY", value);` use similar to PlayerPrefs
+- Save Data: `GameData.Save()` save data to file (You should save when pausing or quitting the game)
+- Has Key: `GameData.HasKey(string key)` to check if the profile has a key,
+- DeleteKey: `GameData.DeleteKey(string key)`to delete the key from the profile
+- DeleteAll: `GameData.DeleteAll()` to delete the entire key

package.json

@@ -1,7 +1,7 @@
 {
   "name": "com.wolf-package.game-data",
   "displayName": "UnityCommon-GameData",
-  "description": "System game data for game unity",
+  "description": "System data for game unity",
   "version": "1.0.0",
   "unity": "2021.3",
   "category": "virtuesky",
@@ -16,5 +16,7 @@
     "Unity",
     "GameData"
   ],
-  "dependencies": {}
+  "dependencies": {
+    "com.unity.serialization": "3.1.1"
+  }
 }