Update alias section in README

zakuro9715 · Feb 23, 2021 · bd2e0bd · bd2e0bd
1 parent fb7e825
commit bd2e0bd
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -177,18 +177,30 @@ hello world
 
 ### Task Alias
 
+Just use z as command. Config will be inherited.
+
 ```yaml
+# myconfig.yaml
 tasks:
     hello.world: echo hello world
-    helloworld:
-        z: hello.world
+    helloworld: z hello world # same as `z --config=myconfig.yaml hello world`
 ```
 
 ```
-$z helloworld
+$z --config=myconfig.yaml helloworld
 hello world
 ```
 
+Of course, you can use another config
+
+```yaml
+tasks:
+    hello:
+        tasks:
+            a: z --config=a.yaml hello
+            b: z --config=b.yaml hello
+```
+
 ### Env
 
 ```

diff --git a/README.template.md b/README.template.md
@@ -177,18 +177,30 @@ hello world
 
 ### Task Alias
 
+Just use z as command. Config will be inherited.
+
 ```yaml
+# myconfig.yaml
 tasks:
     hello.world: echo hello world
-    helloworld:
-        z: hello.world
+    helloworld: z hello world # same as `z --config=myconfig.yaml hello world`
 ```
 
 ```
-$z helloworld
+$z --config=myconfig.yaml helloworld
 hello world
 ```
 
+Of course, you can use another config
+
+```yaml
+tasks:
+    hello:
+        tasks:
+            a: z --config=a.yaml hello
+            b: z --config=b.yaml hello
+```
+
 ### Env
 
 ```