chore(style): add shebang, set bash strict mode, create function

[webi-installers/.git] / mutagen / README.md

diff --git a/mutagen/README.md b/mutagen/README.md
index 03f866b2f893ef61bd0f2dd248fdaeaa4d31125c..39b96c4c0ece293397565f321ad02fe1748576f7 100644 (file)
--- a/mutagen/README.md
+++ b/mutagen/README.md
@@ -1,35 +1,100 @@
 ---
-title: Foo Bar
-homepage: https://github.com/webinstall/foobar
+title: mutagen
+homepage: https://github.com/mutagen-io/mutagen
 tagline: |
-  foobar: An example that doesn't exist.
+  mutagen: Remote development tool
 ---
 
-<!--
-    Note: Delete this comment section.
-
-    Need an example that has an **alias**? See `bat`.
-    Need a Windows example using **msvc**? See `bat`.
--->
-
-To update or switch versions, run `webi example@stable` (or `@v2`, `@beta`,
+To update or switch versions, run `webi mutagen@stable` (or `@v2`, `@beta`,
 etc).
 
 ## Cheat Sheet
 
-> `foo` doesn't exist and this text should have been replaced. It doesn't do
-> anything, but what it does is useful because it is; everybody knows it.
+> Mutagen is a new kind of remote development tool that enables your existing
+> local tools to work with code in remote environments like cloud servers and
+> containers. It does this by providing high-performance real-time file
+> synchronization and flexible network forwarding.
+
+### Creating sessions
+
+Create a synchronization session named "web-app-code" between the local path
+~/project and an SSH-accessible endpoint.
+
+```bash
+mutagen sync create --name=web-app-code ~/project user@example.org:~/project
+```
+
+OR Create a forwarding session named "web-app" between port 8080 on localhost
+and port 1313 inside a Docker container.
+
+```bash
+mutagen forward create --name=web-app tcp:localhost:8080 docker://devcontainer:tcp:localhost:1313
+```
+
+### Listing sessions
 
-To run foo:
+```bash
+mutagen sync list
+```
+
+OR
+
+```bash
+mutagen forward list
+```
+
+### Monitoring a session
+
+```bash
+mutagen sync monitor web-app-code
+```
+
+OR
 
 ```bash
-foo
+mutagen forward monitor web-app
 ```
 
-### Add Baz Highlighting
+### Pausing/resuming sessions
+
+```bash
+mutagen sync pause web-app-code
+```
+
+OR
+
+```bash
+mutagen forward pause web-app
+```
+
+To resume replace `pause` with `resume` in the above commands
+
+### Resetting session
+
+```bash
+mutagen sync reset web-app-code
+```
+
+### Terminating session
+
+```bash
+mutagen sync terminate web-app-code
+```
+
+OR
+
+```bash
+mutagen forward terminate web-app
+```
+
+For general help
+
+```bash
+mutagen --help
+```
 
-To run foo with both bar and baz highlighting turned on:
+For specific command help
 
 ```bash
-foo --bar=baz
+mutagen <command> --help
 ```