From: adithyasunil26 <adithyasunil26@gmail.com>
Date: Tue, 2 Feb 2021 14:15:18 +0000 (+0400)
Subject: Added readme
X-Git-Url: https://git.josue.xyz/?a=commitdiff_plain;h=237b7dc9fc77fe66ae4089908af04a433b271cca;p=webi-installers%2F.git

Added readme
---

diff --git a/mutagen/README.md b/mutagen/README.md
index 03f866b..e887eec 100644
--- a/mutagen/README.md
+++ b/mutagen/README.md
@@ -1,35 +1,75 @@
 ---
-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.
+To update or switch versions, run `webi mutagen@stable` (or `@v2`, `@beta`, etc).
 
-    Need an example that has an **alias**? See `bat`.
-    Need a Windows example using **msvc**? See `bat`.
--->
+## Cheat Sheet
 
-To update or switch versions, run `webi example@stable` (or `@v2`, `@beta`,
-etc).
+> 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.
 
-## Cheat Sheet
+### 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
+```
 
-> `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.
+### Listing sessions
+```bash
+mutagen sync list
+```
+OR
+```bash
+mutagen forward list
+```
 
-To run foo:
+### Monitoring a session
+```bash
+mutagen sync monitor web-app-code
+```
+OR
+```bash
+mutagen forward monitor web-app
+```
 
+### Pausing/resuming sessions
+```bash
+mutagen sync pause web-app-code
+```
+OR
 ```bash
-foo
+mutagen forward pause web-app
 ```
+To resume replace `pause` with `resume` in the above commands
 
-### Add Baz Highlighting
+### Resetting session
+```bash
+mutagen sync reset web-app-code
+```
 
-To run foo with both bar and baz highlighting turned on:
+### Terminating session
+```bash
+mutagen sync terminate web-app-code
+```
+OR
+```bash
+mutagen forward terminate web-app
+```
 
+For general help
 ```bash
-foo --bar=baz
+mutagen --help
+```
+
+For specific command help
+```bash 
+mutagen <command> --help
 ```