Merge pull request #844 from bavix/uuid-docs

add docs bavix/laravel-wallet-uuid

Author: rez1dent3

docs/_sidebar.md

@@ -35,10 +35,6 @@
   - [Batch transactions](batch-transactions)
   - [Batch transfers](batch-transfers)
 
-- Nova
-
-    - [Change of balance](nova-action)
-
 - Purchases
 
     - [Payment](payment)
@@ -54,6 +50,11 @@
     - [Race condition](race-condition) 
     - [Atomic Service](atomic-service) 
 
+- Additions
+
+  - [Wallet Swap](laravel-wallet-swap)
+  - [Wallet UUID](laravel-wallet-uuid)
+
 - Events
 
     - [BalanceUpdatedEvent](balance-updated-event)
@@ -65,6 +66,6 @@
 
     - [Create Wallet](command-create-wallet)
 
-- Additions
+- Nova
 
-    - [Wallet Swap](laravel-wallet-swap)
+  - [Change of balance](nova-action)

docs/laravel-wallet-uuid.md

@@ -0,0 +1,27 @@
+## Laravel Wallet UUID
+
+> Using uuid greatly reduces package performance. We recommend using int.
+
+Often there is a need to store an identifier in uuid/ulid. Since version 9.0 laravel-wallet supports string identifiers, you only need to perform the migration.
+
+To simplify the process, you can use a ready-made package.
+
+> Attention! It will not work to use UUID instead of ID in wallet models; there is a special uuid field for this.
+
+## Composer
+
+The recommended installation method is using [Composer](https://getcomposer.org/).
+
+In your project root just run:
+
+```bash
+composer req bavix/laravel-wallet-uuid
+```
+
+Now you need to migrate!
+
+After migration, you can use the UUID in your models.
+
+You can find implementation examples in the package tests: https://github.com/bavix/laravel-wallet-uuid/tree/master/tests
+
+It worked!