docs: add installation and usage details

2026-03-25 23:51:58 -04:00
parent 6becec0636
commit 5e9a190e67
1 changed files with 24 additions and 1 deletions
@@ -1,7 +1,30 @@
 # rbx-reface
 Restore classic decal faces following the Dynamic Head Migration.

-# Acknowledgements
+Characters wearing a dynamic head that was migrated from a classic face will have their head replaced with the appropriate classic mesh and face. Dynamic heads that were never associated with a classic face are left untouched.
+
+## Installation
+
+Install via [Wally](https://wally.run):
+
+```toml
+[dependencies]
+reface = "secret-rare/rbx-reface@0.1.0"
+```
+
+Alternatively, download the `.rbxm` file from the [Releases](https://github.com/filoxen/rbx-reface/releases) tab and insert it into your place.
+
+## Usage
+
+Call `reface.init()` once from a server `Script`. It will handle all current and future players automatically.
+
+```lua
+local reface = require(game.ServerScriptService.Packages.reface)
+
+reface.init()
+```
+
+## Acknowledgements

 [Dawgra/Facial-Unification](https://github.com/Dawgra/Facial-Unification) was the repo that inspired the creation of this one - it served as a design inspiration for this module.