Skip to content

Commit

Permalink
docs(Readme): Update usage
Browse files Browse the repository at this point in the history
  • Loading branch information
brianp committed Dec 11, 2019
1 parent 101bf98 commit 051f83c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ $ muxed my_project
```shell
Usage:
muxed [options] <project>
muxed edit [options] <project>
muxed new [options] <project>
muxed snapshot [options] <project>
muxed (-h | --help)
Expand All @@ -109,6 +110,7 @@ Usage:
Flags:
-d If you want to create a muxed session without connecting to it
-f Overwrite existing file if one exists
--debug Prints debug information while executing (project opening only)
-h, --help Prints help information
-v, --version Prints version information
Expand All @@ -120,8 +122,9 @@ Args:
<project> The name of your project to open
Subcommands:
new <project> To create a new project file
snapshot -t <tmux_session> <project> Capture a running session and create a config file for it
edit <project> Edit an existing project file
new <project> To create a new project file
snapshot -t session <project> Capture a running session and create a config file for it
```
## Inspiration
Expand Down
8 changes: 4 additions & 4 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@ Flags:
Options:
-p <project_dir> The directory your project config files live in. Defaults to ~/.muxed/
-t <tmux_session> The name of the running TMUX session to codify
-t <session> The name of the running TMUX session to codify
Args:
<project> The name of your project to open
Subcommands:
edit <project> Edit an existing project file
new <project> To create a new project file
snapshot -t session <project> Capture a running session and create a config file for it
edit <project> Edit an existing project file
new <project> To create a new project file
snapshot -t <session> <project> Capture a running session and create a config file for it
";

/// The main execution method.
Expand Down

0 comments on commit 051f83c

Please sign in to comment.