diff --git a/README.md b/README.md index c241928..0b0bb49 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,58 @@ Provides native Apple CoreBluetooth integration for use with Unity. CoreBluetoothForUnity provides an interface that closely mirrors the native CoreBluetooth API. + If you are familiar with CoreBluetooth, you will find it easy to work with this plugin. ## Installation -WIP +Scoped Registry + +- Name: `Teach310` +- URL: `https://registry.npmjs.com` +- Scope: `com.teach310` + +## Sample + +You can download samples from Package Manager. + +#### Light Control + +|Central|Peripheral| +|:--:|:--:| +|lightcontrol_central|![output](https://github.com/teach310/CoreBluetoothForUnity/assets/16421323/ebbc6bc9-59a3-465e-a2f8-0d6aafab0f20)| + -## Usage +#### Button Information -WIP +|Central|Peripheral| +|:--:|:--:| +|![mov_button_information](https://github.com/teach310/CoreBluetoothForUnity/assets/16421323/8b119fda-73c0-44d8-aa53-7690526f88cf)|button_information_peripheral| + +## How to release + +If you create a new instance like CBCentralManager, CBMutableService with using "new" keyword, +you must call Dispose() method when you don't need it anymore. + +```csharp +CBCentralManager _centralManager; + +... + +void OnDestroy() +{ + if (_centralManager != null) + { + _centralManager.Dispose(); + _centralManager = null; + } +} +``` ## Feature Requests -This plugin isn't support all of CoreBluetooth features yet. +This plugin isn't support all of CoreBluetooth features yet. + If you want to add some features, please create an issue or pull request. ## License