Merge pull request 'Updating README' (#2) from README into main

Reviewed-on: #2

.ninjasurge.sh

@@ -1,8 +1,8 @@
 #!/bin/bash
-VERSION=v0.0.3
+VERSION=v0.0.4
 
 CONTAINER_NAME=$(basename $PWD)
-IMAGE=hello-world
+IMAGE=ubuntu:latest
 PORT=3000 # Both host and container
 
 

README.md

@@ -1,3 +1,43 @@
 # NinjaSurge.sh
 
-This project serves to manage the .ninjasurge.sh file that I use in my dev work for my utility functions, including custom dev container.
+This project serves to manage the .ninjasurge.sh file that I use in my dev work for my utility functions, including custom dev container.
+
+## Install
+
+1. Download the `.ninjasurge.sh` file to your project folder
+   ```bash
+   curl https://gitea.computersurge.dev/ninjasurge/ninjasurge.sh/releases/download/latest/.ninjasurge.sh -o .ninjasurge.sh
+   ```
+2. Source the `.ninjasurge.sh` file
+   ```bash
+   source .ninjasurge.sh
+   ```
+3. Run `runDev`
+
+## Usage
+
+### Commands
+
+| Command    | Function                                                                  |
+| ---------- | :------------------------------------------------------------------------ |
+| `runDev`   | Create and initialize the development container.                          |
+| `startDev` | Start project development container _(if `runDev` has already been run.)_ |
+| `enterDev` | Enter the development container shell.                                    |
+| `stopDev`  | Stop the development container.                                           |
+| `cleanDev` | Stop and remove the development container                                 |
+| `resetDev` | Stop, Remove, and Recreate the development container                      |
+| `dexec`    | Run a docker exec command in the development container                    |
+
+### Configuration Variables
+
+| Variable         | Default       | Function                                            |
+| ---------------- | ------------- | :-------------------------------------------------- |
+| `VERSION`        | _NA_          | This is the script version                          |
+| `CONTAINER_NAME` | set by script | The name of the development container               |
+| `IMAGE`          | hello-world   | The docker image used for the development container |
+| `PORT`           | 3000          | The port that is exposed                            |
+
+## Roadmap
+
+- [ ] Auto "unsource" the file when the project directory is left
+- [ ] Find better default image that will work out of the box in most senarios