Update README, change -get to -save, allow for locking/unlocking via …

…CLI, fixes nil pointer dereference

README.md

@@ -25,52 +25,224 @@ go install github.com/Nigel2392/quickgo/[email protected]
 
 # Usage
 
-(This part will be expanded upon in the near future)
+## List all the projects you've saved
+
+To list all the projects which you've saved we provide the `-list` flag.
+
+Example:
+
+```bash
+quickgo -list
+```
+
+## Configuring your project templates
+
+### Example configuration
+
+We provide a command to easily generate an example configuration file for quickgo.
+
+This provides a good starting point for creating your own project configurations.
+
+```bash
+quickgo -example
+```
+
+Now you should have a `quickgo.yaml` file in your current directory.
+
+### `quickgo.yaml`
+
+The `quickgo.yaml` file is where you define your project templates and commands.
+
+It allows for the following fields:
+
+- `name`: The name of the project.
+- `context`: The context to use for the project templates.
+- `delimLeft`: The left delimiter for the project templates.
+- `delimRight`: The right delimiter for the project templates.
+- `exclude`: A list of files to exclude from the project in glob format. (e.g. `*.go`)
+- `beforeCopy`: A list of commands to run before copying the project templates.
+- `afterCopy`: A list of commands to run after copying the project templates.s
+- `commands`: A list of commands to run before and after copying the project templates.
+
+## Saving your project templates
+
+After you have configured your project in `quickgo.yaml`, you can save them with the following commands.
+It is however fully possible to skip creating a `quickgo.yaml` file and control everything via the command line.
+
+```bash
+# Save the project (this will be saved in $HOME/.quickgo/projects).
+quickgo -save 
+
+# Save the project, override the name and context:
+quickgo -save -name my-custom-project / customContextKey=customContextValue
+
+# Save the project, exclude all files matching the glob pattern `*.go` and `*.mod`.
+quickgo -save -e '*.go' -e '*.mod'
+```
+
+## Using your project templates
+
+Now that you have created some project templates, you can use them with the following command:
+
+```bash
+# Create a new project from the template.
+# This will create a new project in the `my/target/directory/my-project` directory.
+quickgo -use my-project -d my/target/directory
+```
+
+We also allow for a few overrides when using your project templates, you can provide extra context or change the project name.
+
+This can be done by delimiting your context with a slash when running the above command.
+
+Example:
+
+```bash
+# Create a new project from the template.
+# Change the name, provide extra context and change the target directory.
+# This will create a new project in the `my/target/directory/my-custom-project-name` directory.
+quickgo -use my-project -d my/target/directory -name my-custom-project-name / customContextKey=customContextValue
+```
+
+## Locking the project configuration.
+
+If you want to lock the project configuration, you can do so by providing the `-lock` flag.
+
+This will prevent the project configuration and files from being modified by QuickGo.
+
+* 1 = Lock
+* 0 = Unlock
+
+Example:
+
+```bash
+# Lock the current project configuration.
+quickgo -lock 1
+```
+
+## Using your defined project's commands
+
+You can also run the commands defined in your `quickgo.yaml` file.
+
+It is also possible to provide the `-d` flag to run the commands in the project's directory.
+
+```bash
+# Run the `echoName` command defined in the `quickgo.yaml` file.
+# This will echo the project name.
+quickgo echoName
+
+# Run the `echoName` command defined in the `myconfig/quickgo.yaml` file.
+quickgo -d 'myconfig' echoName customProjectName="custom-${projectName}"
+```
+
+These are addressed by the label of the steps.
+
+Example:
+
+```bash
+# Run the `echoName` command defined in the `quickgo.yaml` file.
+# This will echo the project name.
+quickgo echoName
+
+# Run the `echoName` command defined in the `quickgo.yaml` file.
+# Provide a custom project name to echo.
+# This will echo the custom project name.
+quickgo echoName customProjectName="custom-${projectName}"
+```
+
+## All available application flags:
 
 ```bash
- $$$$$$\            $$\           $$\           $$$$$$\
-$$  __$$\           \__|          $$ |         $$  __$$\
-$$ /  $$ |$$\   $$\ $$\  $$$$$$$\ $$ |  $$\    $$ /  \__| $$$$$$\   ####
-$$ |  $$ |$$ |  $$ |$$ |$$  _____|$$ | $$  |   $$ |$$$$\ $$  __$$\
-$$ |  $$ |$$ |  $$ |$$ |$$ /      $$$$$$  /    $$ |\_$$ |$$ /  $$ |   ######
-$$ $$\$$ |$$ |  $$ |$$ |$$ |      $$  _$$<     $$ |  $$ |$$ |  $$ |
-\$$$$$$ / \$$$$$$  |$$ |\$$$$$$$\ $$ | \$$\    \$$$$$$  |\$$$$$$  | #####
- \___$$$\  \______/ \__| \_______|\__|  \__|    \______/  \______/
-     \___|
-
-
-Created by: Nigel van Keulen
-QuickGo: A simple project generator and server.
-Usage: quickgo [flags | command] [?args]
-Available application flags:
-  -d
-    d: The target directory to write the project to.
-  -delim-left
-    delim-left: The left delimiter for the project templates.
-  -delim-right
-    delim-right: The right delimiter for the project templates.
-  -e
-    e: A list of files to exclude from the project in glob format.
-  -example=false
-    example: Print an example project configuration.
-  -get
-    get: Import the project from the current directory.
-  -host=localhost
-    host: The host to run the server on.
-  -list=false
-    list: List the projects available for use.
-  -name
-    name: The name of the project.
-  -port=8080
-    port: The port to run the server on.
-  -serve=false
-    serve: Serve the project over HTTP.
-  -tls-cert
-    tls-cert: The path to the TLS certificate.
-  -tls-key
-    tls-key: The path to the TLS key.
-  -use
-    use: Use the specified project configuration.
-  -v=false
-    v: Enable verbose logging.
+-d: The target directory to write the project to.
+-delim-left: The left delimiter for the project templates.
+-delim-right: The right delimiter for the project templates.
+-e: A list of files to exclude from the project in glob format.
+-example=false: Print an example project configuration.
+-save=false: Import the project from the current directory.
+-host=localhost: The host to run the server on.
+-list=false: List the projects available for use.
+-lock=-1: Lock the project configuration. 1=Lock, 0=Unlock.
+-name: The name of the project.
+-port=8080: The port to run the server on.
+-serve=false: Serve the project over HTTP.
+-tls-cert: The path to the TLS certificate.
+-tls-key: The path to the TLS key.
+-use: Use the specified project configuration.
+-v: Enable verbose logging.
+```
+
+
+### Example `quickgo.yaml` configuration
+
+See the example file below to get a better understanding of how to configure your project templates.
+
+```yaml
+# The name of your project template.
+# This is how you want it to be adressed when using the template.
+# It can optionally be overridden, example: `quickgo -get my-project -name my-custom-project-name`
+name: my-project
+
+# Optional extra context that can be used in text files throughout your project.
+# These can also be used when running commands like beforeCopy, afterCopy and the project commands themselves.
+# Example: `{{projectName}}` will be replaced with `My Project` in all files, if the leftDelim and rightDelim are set to `{{` and `}}`.
+context:
+    Name: My Project
+
+
+# The left and right delimiters for the template engine.
+# These are used to replace the context variables in the project files.
+# Example: `{{ projectName }}` will be replaced with `My Project` in all files, if the leftDelim and rightDelim are set to `{{` and `}}`.
+delimLeft: ${{
+delimRight: '}}'
+
+# A list of files and directories to exclude from the project template.
+# These will not be saved; there is currently no way to exclude files after saving.
+exclude:
+    - '*node_modules*'
+    - '*dist*'
+    - .git
+
+# A list of steps to run before copying the template to the destination.
+# This can be used to prepare the project files, etc.
+# The project is not yet copied to the destination at this point.
+beforeCopy:
+    # This will execute:
+    #   echo $projectPath  
+    steps:
+        - name: Echo Project Path Before
+          command: echo
+          args:
+            - $projectPath
+
+# A list of steps to run after copying the template to the destination.
+# This can be used to clean up, install dependencies, etc.
+# The project is already copied to the destination at this point.
+afterCopy:
+    steps:
+        - name: Echo Project Name After
+          command: echo
+          args:
+            - $projectName
+
+# A list of custom commands that can be run on the project.
+# These can be used to automate tasks, etc.
+# Example: `quickgo <command-name> <args>`
+commands:
+
+    # The label is the name of the command.
+    echoName:
+
+        # Description is only used for type annotations.
+        description: Echo the project name, supply one with customProjectName=myValue
+
+        # Arguments which can be setup before running the command.
+        args:
+            customProjectName: $projectName
+
+        # The steps which will be executed when running the command.
+        steps:
+            steps:
+                - name: Echo Project Name
+                  command: echo
+                  args:
+                    - $customProjectName
 ```