Documented component git and added plugin description

reactive-graph · Jan 22, 2023 · b7983a8 · b7983a8
1 parent 7ae0397
commit b7983a8
Showing 1 changed file with 17 additions and 9 deletions.
diff --git a/plugins/git/README.md b/plugins/git/README.md
@@ -1,17 +1,25 @@
 # Plugin Git
 
+This plugin provides git functionality. You can clone a repository, fetch, pull and fast-forward.
+
 ## Component
 
-| Property      | Component           | DataType | SocketType | Description                                               |
-|---------------|---------------------|----------|------------|-----------------------------------------------------------|
-| `name`        | `base__named`       | `String` | `none`     | The name.                                                 |
-| `description` | `base__describable` | `String` | `none`     | The description.                                          |
-| `url`         | `http__url`         | `String` | `none`     | The remote url.                                           |
-| `file`        | `file_file`         | `String` | `none`     | The local path.                                           |
-| `branch`      | `git__git`          | `String` | `none`     | The git branch name. Executes a `git checkout` on change. |
+| Property        | Component           | DataType  | SocketType | Description                                               |
+|-----------------|---------------------|-----------|------------|-----------------------------------------------------------|
+| `name`          | `base__named`       | `String`  | `none`     | The name.                                                 |
+| `description`   | `base__describable` | `String`  | `none`     | The description.                                          |
+| `url`           | `http__url`         | `String`  | `input`    | The remote url.                                           |
+| `file`          | `file_file`         | `String`  | `input`    | The local path.                                           |
+| `branch`        | `git__git`          | `String`  | `input`    | The git branch name. Executes a `git checkout` on change. |
+||
+| `remote_name`   | `git__git`          | `String`  | `input`    | The name of the remote (default: `origin`).               |
+| `remote_branch` | `git__git`          | `String`  | `input`    | The name of the remote branch                             |
 ||
-| `merge_from`  | `git__git`          | `String` | `input`    | Merges the given branch into the current branch           |
-| `push`        | `git__git`          | `String` | `input`    | Pushes to the given remote (by default origin)            |
+| `trigger`       | `git__git`          | `Bool`    | `input`    | Clone or pull                                             |
+| `fetch`         | `git__git`          | `Bool`    | `input`    | Fetch                                                     |
+| `fast_forward`  | `git__git`          | `Bool`    | `input`    | Fast-forward                                              |
+| `push`          | `git__git`          | `Bool`    | `input`    | Pushes to the given remote (by default origin)            |
+| `merge_from`    | `git__git`          | `String`  | `input`    | Merges the given branch into the current branch           |
 
 ## Platform Compatibility