Merge pull request #14 from codenamephp/updatedReadme

Updated readme

Author: bastianschwarz

.github/workflows/ci.yml

@@ -4,13 +4,11 @@ on:
   merge_group:
   push:
     branches:
-      - main
       - release
     paths-ignore:
       - '**.md'
   pull_request:
     branches:
-      - main
       - release
     paths-ignore:
       - '**.md'

README.md

@@ -12,4 +12,21 @@
 
 Easiest way is via composer. Just run `composer require codenamephp/deployer.crontab` in your cli which should install the latest version for you.
 
-## Usage
+## Usage
+
+Just install the package and use the task in your deploy.php, e.g:
+
+```php
+
+$deployerFunctions = new \de\codenamephp\deployer\base\functions\All();
+$deployerFunctions->registerTask(new \de\codenamephp\deployer\crontab\Task\Install()); //expects file in {{release_or_current_path}}/crontab -> crontab {{release_or_current_path}}/crontab
+$deployerFunctions->registerTask(new \de\codenamephp\deployer\crontab\Task\Install('path/to/file')); // crontab path/to/file
+$deployerFunctions->registerTask(new \de\codenamephp\deployer\crontab\Task\Install('path/to/file', 'deployerUser')); // crontab -u deployerUser path/to/file
+$deployerFunctions->registerTask(new \de\codenamephp\deployer\crontab\Task\Show()); // crontab -l
+$deployerFunctions->registerTask(new \de\codenamephp\deployer\crontab\Task\Show('deployerUser')); // crontab -u deployerUser -l
+$deployerFunctions->registerTask(new \de\codenamephp\deployer\crontab\Task\Delete()); // crontab -r
+$deployerFunctions->registerTask(new \de\codenamephp\deployer\crontab\Task\Delete('deployerUser')); // crontab -u deployerUser -r
+```
+`vendor/bin/dep crontab:install`
+`vendor/bin/dep crontab:show`
+`vendor/bin/dep crontab:delete`