expand README.md

LBannenberg · Jan 7, 2024 · 89b8ca0 · 89b8ca0
1 parent d991035
commit 89b8ca0
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -21,3 +21,5 @@ Homestead.yaml
 Homestead.json
 /.vagrant
 .phpunit.result.cache
+
+.idea
diff --git a/README.md b/README.md
@@ -1,2 +1,26 @@
 # laravel-mysqldump
-A laravel package with artisan commands to dump and import mysql databases or tables
+
+## Purpose
+
+* Easily dump whole databases or specific tables, with `artisan mysql:export`
+* Easily import, with `artisan mysql:import`
+* Strip content from tables, for example, strip the customer data but keep the product catalog.
+
+
+## Credits
+
+This package makes heavy use of [spatie/db-dumper](https://github.com/spatie/db-dumper). The original inspiration is based on [magerun2](https://github.com/netz98/n98-magerun2) and [mage-db-sync](https://github.com/jellesiderius/mage-db-sync). 
+
+## Setup
+
+Install with: 
+```bash
+composer require corrivate/laravel-mysqldump
+```
+
+## Configuration
+In your `config/database.php` you can add configuration for stripping tables:
+
+![](docs/config.png)
+
+
diff --git a/docs/config.png b/docs/config.png