Merge pull request #35 from OnitaAndrei/issue-31

added lock files documentation

Author: arhimede

docs/book/v3/lock-files.md

@@ -0,0 +1,14 @@
+# Lock Files
+
+When a command starts running, a lock file is created for that command.
+The lock file ensures that the same command would not run before the previous one is done.
+If a command was force stopped, locate the lock file in the configured directory and delete it to refresh the command.
+
+## Configuration
+
+Inside `config/autoload/cli.global.php` under the `FileLockerInterface::class` key the file locker can be disabled and the location of the lock files can be changed
+
+    FileLockerInterface::class => [
+        'enabled' => true,
+        'dirPath' => getcwd() . '/data/lock',
+    ],

docs/book/v3/setting-up-as-cronjob.md

@@ -1,15 +1,15 @@
 # Setting up as cronjob
 
 ```text
-*   *   *   *   *   /opt/plesk/php/7.4/bin/php /var/www/vhosts/example.com/httpdocs/bin/cli.php demo:command -q
+*   *   *   *   *   php /var/www/vhosts/example.com/httpdocs/bin/cli.php demo:command -q
 ```
 
 or
 
 ```text
-*   *   *   *   *   cd /var/www/vhosts/example.com/httpdocs/bin && /opt/plesk/php/7.4/bin/php ./cli.php demo:command -q
+*   *   *   *   *   cd /var/www/vhosts/example.com/httpdocs/bin && php ./cli.php demo:command -q
 ```
 
-Adapt the command to your specifications by replacing **7.4** with your PHP version and **example.com** with your domain name.
+Adapt the command to your specifications by replacing **example.com** with your domain name.
 
 Note the **-q** (or **--quiet**) option at the end of the command - it serves as a flag to inform the Application that no output should be returned (unless it's an error).

mkdocs.yml

@@ -8,11 +8,12 @@ extra:
 nav:
   - Home: index.md
   - v3:
-      - Configuration: v3/configuration.md
       - Installation: v3/installation.md
-      - "Setting Up As Cronjob": v3/setting-up-as-cronjob.md
+      - Configuration: v3/configuration.md
+      - "Lock Files": v3/lock-files.md
       - Testing: v3/testing.md
       - Usage: v3/usage.md
+      - "Setting Up As Cronjob": v3/setting-up-as-cronjob.md
 site_name: dot-cli
 site_description: "DotKernel's component to build console applications"
 repo_url: "https://github.com/dotkernel/dot-cli"