From 87c5107bda30a70530250409b5caae25c60725e0 Mon Sep 17 00:00:00 2001
From: Pavel Shevaev <ps@bit.games>
Date: Fri, 12 Apr 2024 13:10:43 +0300
Subject: [PATCH] =?UTF-8?q?=D0=9E=D0=B1=D0=BD=D0=BE=D0=B2=D0=B8=D1=82?=
 =?UTF-8?q?=D1=8C=20README.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 54 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 8e3ad7a..5b242a1 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,6 @@ Here's a simple example of a task:
 ``` 
 <?php
 namespace taskman;
-use Exception;
 
 task('hello', function() 
 {
@@ -36,7 +35,6 @@ Hello world!
 ```
 <?php
 namespace taskman;
-use Exception;
 
 task('ultimate_build_run', 
   [
@@ -76,13 +74,24 @@ Available tasks:
 ***** All done (0.01 sec.) *****
 ```
 
+You can filter tasks you want to get help for by a partial match as follows:
+
+```
+./gamectl help name
+```
+
 ### Tasks documentation 
 
 #### Task declaration
 
 Task must be declared using library **task** function as follows:
 
-```task('name', function() {});``` 
+```
+<?php
+namespace taskman;
+
+task('name', function() {});
+``` 
 
 The task above now can be invoked from the shell as follows:
 
@@ -93,6 +102,9 @@ The task above now can be invoked from the shell as follows:
 Task may have an alias for less typing in the shell. To specify an alias one should put it as an **alias** property of a task declaration:
 
 ```
+<?php
+namespace taskman;
+
 task('name', ['alias' => 'n'], 
    function() {});
 ``` 
@@ -106,6 +118,9 @@ You can invoke the task by the alias as follows:
 Task may have an dependencies on other tasks. To specify all dependencies one should list them in **deps** section of a task declaration:
 
 ```
+<?php
+namespace taskman;
+
 task('c', ['deps' => ['a', 'b']], 
    function() {});
 ``` 
@@ -122,11 +137,46 @@ All dependencies are executed before running the specified task. Running the tas
 ***** All done (0.18 sec.) *****
 ```
 
-#### Task executed always
+#### Always executed tasks
 
 Sometimes it's convenient to define tasks which should be executed every time without explicit invocation. For example for setting the up the default environment, properties, etc. To achieve that one should specify the **always** property for a task:
 
 ```
+<?php
+namespace taskman;
+
 task('setup_env', ['always' => true], 
    function() {});
 ``` 
+
+### Build properties
+
+It's possible to specify miscellaneous build properties to setup a proper build environment conditions. There's a set of routines which provides taskman for properties manipulation.
+
+### Setting a property
+
+Use **set** built-in function:
+
+```
+<?php
+namespace taskman;
+
+task('setup_env', ['always' => true], 
+   function() {
+      set("IOS_APP_ID", "4242jfhFD");
+   });
+``` 
+
+### Getting a property
+
+Use **get** built-in function:
+
+```
+<?php
+namespace taskman;
+
+task('build_ios', 
+   function() {
+      shell("xcode build app " . get("IOS_APP_ID"));
+   });
+```