Skip to content

Commit a80308d

Browse files
Update readme
Signed-off-by: Jacob Stopak <jacob@initialcommit.io>
1 parent f43454a commit a80308d

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -81,19 +81,20 @@ $ git-sim [global options] <subcommand> [subcommand options]
8181

8282
The `[global options]` apply to the overarching `git-sim` simulation itself, including:
8383

84-
`--light-mode`: Use a light mode color scheme instead of default dark mode.
85-
`--animate`: Instead of outputting a static image, animate the Git command behavior in a .mp4 video.
86-
`--reverse`: Display commit history in the reverse direction.
84+
`--light-mode`: Use a light mode color scheme instead of default dark mode.
85+
`--animate`: Instead of outputting a static image, animate the Git command behavior in a .mp4 video.
86+
`--disable-auto-open, -d`: Disable the automatic opening of the image/video file after generation.
87+
`--reverse, -r`: Display commit history in the reverse direction.
8788

8889
Animation-only global options (to be used in conjunction with `--animate`):
8990

90-
`--speed=n`: Set the multiple of animation speed of the output simulation, `n` can be an integer or float, default is 1.
91-
`--low-quality`: Render the animation in low quality to speed up creation time, recommended for non-presentation use.
92-
`--show-intro`: Add an intro sequence with custom logo and title.
93-
`--show-outro`: Add an outro sequence with custom logo and text.
94-
`--title=title`: Custom title to display at the beginning of the animation.
95-
`--logo=logo.png`: The path to a custom logo to use in the animation intro/outro.
96-
`--outro-top-text`: Custom text to display above the logo during the outro.
91+
`--speed=n`: Set the multiple of animation speed of the output simulation, `n` can be an integer or float, default is 1.
92+
`--low-quality`: Render the animation in low quality to speed up creation time, recommended for non-presentation use.
93+
`--show-intro`: Add an intro sequence with custom logo and title.
94+
`--show-outro`: Add an outro sequence with custom logo and text.
95+
`--title=title`: Custom title to display at the beginning of the animation.
96+
`--logo=logo.png`: The path to a custom logo to use in the animation intro/outro.
97+
`--outro-top-text`: Custom text to display above the logo during the outro.
9798
`--outro-bottom-text`: Custom text to display below the logo during the outro.
9899

99100
The `[subcommand options]` are like regular Git options specific to the specified subcommand (see below for a full list).
@@ -140,6 +141,7 @@ Usage: `git-sim commit -m "Commit message"`
140141
- Specify your commit message after the -m option
141142
- HEAD and the active branch will be moved to the new commit
142143
- Simulated output will show files in the staging area being included in the new commit
144+
- Supports amending the last commit with: `$ git-sim commit --amand -m "Amended commit message"
143145

144146
![git-sim-commit_01-05-23_22-10-21](https://user-images.githubusercontent.com/49353917/210941149-d83677a1-3ab7-4880-bc0f-871b1f150087.jpg)
145147

0 commit comments

Comments
 (0)