Skip to content

Commit d492d9f

Browse files
authored
Update README.md
1 parent 4c31152 commit d492d9f

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ php artisan vendor:publish --tag=blockchain-migrations
4646
php artisan migrate
4747
```
4848

49-
## Configuration
49+
## ⚙️ Configuration
5050

5151
The configuration file is located at `config/blockchain.php`. Key settings include:
5252

@@ -63,7 +63,7 @@ return [
6363
];
6464
```
6565

66-
## Generate Keys
66+
## 🔑 Generate Keys
6767

6868
Generate RSA key pair for signing blockchain blocks:
6969

@@ -83,7 +83,7 @@ BLOCKCHAIN_PRIVATE_KEY_PASSWORD=yourpassword
8383

8484
## Usage
8585

86-
### Basic Usage
86+
### 🧩 Basic Usage
8787

8888
```php
8989
use RonaldPH\LaravelBlockchain\Facades\Blockchain;
@@ -102,7 +102,7 @@ $block = Blockchain::createBlock(
102102
);
103103
```
104104

105-
### Using with Request (File Upload)
105+
### 📤 Using with Request (File Upload)
106106

107107
```php
108108
use Illuminate\Http\Request;
@@ -136,7 +136,7 @@ public function store(Request $request)
136136
}
137137
```
138138

139-
### Update Records
139+
### 🔄 Update & Chain Blocks
140140

141141
```php
142142
// Update user
@@ -149,7 +149,7 @@ $block = Blockchain::createBlock(
149149
$user->only('id', 'email', 'updated_at')
150150
);
151151
```
152-
152+
## 🔍 Verification
153153
### Verify a Block
154154

155155
```php
@@ -204,7 +204,7 @@ foreach ($history as $block) {
204204
}
205205
```
206206

207-
### Using Custom Keys
207+
### 🔐 Using Custom Keys
208208

209209
```php
210210
// Set custom private and public keys
@@ -217,7 +217,7 @@ $result = Blockchain::setPublicKey('/path/to/public.pem')
217217
->verifyBlock($blockHash);
218218
```
219219

220-
## Artisan Commands
220+
## 🧰 Artisan Commands
221221

222222
### Verify Chain
223223

@@ -231,9 +231,9 @@ Output:
231231
Total blocks verified: 5
232232
```
233233

234-
## Advanced Usage
234+
## 🧠 Advanced Usage
235235

236-
### Model Trait (Optional)
236+
### 🔸 Model Trait (Optional)
237237

238238
Create a trait to easily add blockchain to your models:
239239

@@ -281,7 +281,7 @@ $history = $user->getBlockchainHistory();
281281
$result = $user->verifyBlockchain();
282282
```
283283

284-
### Model Events (Auto-create blocks)
284+
### 🔸 Model Events (Auto-create blocks)
285285

286286
```php
287287
class User extends Model
@@ -309,7 +309,7 @@ class User extends Model
309309
}
310310
```
311311

312-
## API Example
312+
## 🌐 API Endpoints Example
313313

314314
```php
315315
Route::prefix('blockchain')->group(function () {
@@ -320,7 +320,7 @@ Route::prefix('blockchain')->group(function () {
320320
});
321321
```
322322

323-
## How It Works
323+
## ⚙️ How It Works
324324

325325
1. **Block Creation**: When you create a block, the package:
326326
- Hashes your data using SHA-256
@@ -341,27 +341,27 @@ Route::prefix('blockchain')->group(function () {
341341
- Cryptographic proof of authenticity
342342
- Tamper-evident history
343343

344-
## Security Considerations
344+
## 🛡️ Security Recommendations
345345

346-
- **Store keys securely**: Never commit private keys to version control
347-
- **Use strong passwords**: Protect your private key with a strong password
348-
- **Restrict key access**: Limit who can access private keys
349-
- **Regular backups**: Backup your keys and blockchain data
350-
- **Key rotation**: Consider rotating keys periodically
346+
- 🔐 Never commit private keys to version control
347+
- 🧱 Store keys in **storage/** with correct permissions
348+
- 💪 Use strong passwords and rotate keys periodically
349+
- 💾 Regularly back up both keys and ledger data
351350

352-
## Testing
351+
## 🧪 Testing
353352

354353
```bash
355354
composer test
356355
```
357356

358-
## License
357+
## 📜 License
359358

360-
MIT License
359+
This package is open-sourced software licensed under the [MIT License](https://github.com/Ronald-PH/laravel-blockchain/?tab=MIT-1-ov-file)
361360

362-
## Credits
361+
## 💡 Credits
363362

364-
- Ronald PH
363+
Developed by **Ronald PH**<br>
364+
📦 [GitHub Repository](https://github.com/ronald-ph/laravel-blockchain)
365365

366366
## Support
367367

0 commit comments

Comments
 (0)