docs(update doc): update doc

bingryan · Aug 30, 2021 · 5ca2ec2 · 5ca2ec2
1 parent cd55b87
commit 5ca2ec2
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -17,4 +17,3 @@
 
 .idea/
 **/expand.rs
-.local/Call.yml
diff --git a/Call.yml b/Call.yml
@@ -0,0 +1,20 @@
+call:
+  config:
+    active:
+      openssh:
+        - dev
+    runner: make
+  mapping:
+      src: .
+      dest: ~/workspace/call-2.0
+      exclude:
+          - ./target
+          - README.md
+  server:
+        openssh:
+          dev:
+              host:
+                - 192.168.2.26
+              port: 22
+              authentication_type: openssh
+              username: rust
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "rust-call"
-version = "0.2.0"
+version = "0.3.0"
 authors = ["bingryan <[email protected]>"]
 edition = "2018"
 license = "Apache-2.0"

diff --git a/README.md b/README.md
@@ -129,7 +129,11 @@ $ brew install http://git.io/sshpass.rb(if notwork, copy raw content to `sshpass
 * [ ]  ~~Call Server(Relay Server):  relay server which is able to coordinate with clients to establish connectivity(use other port forward tools).~~
 * [x]  default template(Put the template.yml under ~/.call/template.yml and copy it directly when run: call i)
 
+## Tutorial
+
+[Tutorial Doc](./docs/tutorial.md)
+
 ## Contributing
 
-Contributors are welcomed to join this project. Please check [CONTRIBUTING](./CONTRIBUTING.md) about how to contribute
+Contributors are welcomed to join this project. Please check [CONTRIBUTING](./.github/CONTRIBUTING.md) about how to contribute
 to this project.
diff --git a/docs/tutorial.md b/docs/tutorial.md
@@ -0,0 +1,3 @@
+# tutorial
+
+TODO