feat: add readme

Author: Sudheer Tripathi

README.md

@@ -1,7 +1,27 @@
 # dcmv
 
-Update .env references to other containers when running a container from outside docker.
+A CLI utility to update .env references to other containers when moving containers
+inside/outside docker. 
 
+`dcmv` is short for docker-compose move. 
+`dcmv` is useful in case you need to run certain containers outside docker for faster debugging or for tooling reasons. 
+
+## Run from source
+
+1. Make sure you have `Deno` installed on your system
+2. Compile to native binary
+```sh
+deno run compile
+```
+3. Add to $PATH
+```sh
+mkdir -p $HOME/.dcmv
+mv ./dcmv $HOME/.dcmv
+
+# Replace ~/.zshrc with your profile: ~/.bashrc, ~/.profile, etc
+echo 'export PATH="$PATH:$HOME/.dcmv"' >> ~/.zshrc
+source ~/.zshrc
+```
 
 ## Features
 
@@ -10,44 +30,26 @@ Update .env references to other containers when running a container from outside
 - Provides a preview of the changes to be made before applying them.
 - Supports multiple services and their dependencies.
 
-## Usage
-
-To use this utility, run the following command in your terminal:
-
-```bash
-deno run -A src/cli.ts
-```
-
-This will start the utility and guide you through the process of moving services
-in or out of Docker containers.
-
-## Options
-
-The utility accepts the following options:
-
-- `--out` or `-o`: Move the service outside Docker.
-- `--in` or `-i`: Move the service inside Docker.
-- `--service` or `-s`: Specify the service name to be moved.
-- `--help` or `-h`: Display help and exit.
 
-## Examples
+## Usage Examples
+Run it in the directory which has your docker-compose file.
 
 To move a service named `service1` outside Docker, run:
 
 ```bash
-deno run src/cli.ts --out --s service1
+dcmv --out --s service1
 ```
 
 To move a service named `service2` inside Docker, run:
 
 ```bash
-deno run src/cli.ts --in --s service2
+dcmv --in --s service2
 ```
 
 ## Contributing
 
 Contributions are welcome! If you'd like to contribute to this project, please
-fork the repository, make your changes, and submit a pull request.
+fork the repository, make your changes, and submit a pull request. Likewise, if you find any issues with the tool, feel free to raise an issue.
 
 ## License
 

deno.json

@@ -2,20 +2,20 @@
   "name": "@dcode/dcmv",
   "version": "1.0.1",
   "description": "Automatically update .env references to other containers when moving a container outside/inside docker",
-  "exports": "./src/cli.ts",
+  "exports": "./src/main.ts",
   "publish": {
     "include": [
       "README.md",
       "src/**/*.ts"
     ]
   },
   "tasks": {
-    "dev": "deno run -A src/cli.ts",
-    "compile": "deno compile -A  --output ./dcmv src/cli.ts",
+    "dev": "deno run -A src/main.ts",
+    "compile": "deno compile -A  --output ./dcmv src/main.ts",
     "test": "deno test -A tests",
     "fmt": "deno fmt",
     "lint": "deno lint",
-    "dev:inspect": "deno run --watch src/cli.ts"
+    "dev:inspect": "deno run --watch src/main.ts"
   },
   "imports": {
     "@std/assert": "jsr:@std/assert@1",