Readies readme for release

README.md

@@ -2,32 +2,94 @@
 
 A VS Code extension to make GMod addon development easier.
 
-# Resources
-* Icons from [Font Awesome](https://fontawesome.com/icons/list) and [VS Code Extension Examples](https://github.com/microsoft/vscode-extension-samples/)
+With this, you can quickly create and upload Garry's Mod addons to the workshop.
 
 <br>
+
+It is recommended that you also install the [GLua language support extension](https://marketplace.visualstudio.com/items?itemName=aStonedPenguin.glua), for improved syntax highlighting and suggestions.
+
+
 <br>
 
-## Features
-* 
+# Create your first Workshop item
+1. Open a folder in VS Code and click Create Addon
+![create-addon-button](resources/readme/create-addon-1.png)
 
+2. Add your content to the addon.<br>
+For example, create a weapon using the weapons interface.
+![create-addon-button](resources/readme/create-addon-2.png)
 
+3. Upload your addon to the workshop (Steam must be running).<br>
+![create-addon-button](resources/readme/create-addon-3.png)
 
 <br>
 <br>
 
+# Features
 
+## Addon Development
+_Create and use an addon within minutes!_
 
-# Local development
+* Create an addon from an empty folder
+* Copy an addon project to your Garry's Mod folder (and use it in-game!)
+* Create a Garry's Mod weapon from different templates for TTT and Sandbox
+
+<br>
+
+_Copy addons to your Garry's Mod folder and test them in-game_ <br>
+![copy-to-local-garrysmod-folder](resources/readme/features-copy-to-gmod.png)
 
-## Setup
-From the root folder of this project, run
-> npm install
 
 <br>
 
+## Workshop Tools
+_Manage your workshop files at the click of a button!_
+
+* Upload an addon to your workshop- maps, weapons, gamemodes, etc.
+* Update an existing addon on the workshop
+* Change an addon's thumbnail
 
-## Debugging
-* Open the project folder in VS Code and press `F5` to start debugging
-    * This will open a new, `debug instance of VS Code` with this extension installed.
-    * Use `ctrl+r` to reload this window after making changes
+
+<br>
+<br>
+
+
+# Configuration
+1. Press `ctrl` + `,` or go to `File` -> `Preferences` -> `Settings`
+2. Search for `gmod-sdk`
+
+<br>
+
+## Set your Garry's Mod folder location
+
+In order for this extension to work, it needs to know where your Garry's Mod folder is located. <br>
+In the settings, you will need to set your
+
+* Addons folder location
+* gmpublish program location
+* gmad program location
+
+If you need help finding these things, there is a helpful guide [here](https://gist.github.com/BadgerCode/00600eab40556c6e8809590d263ea053).
+
+![configuration-example](resources/readme/configuration.png)
+
+
+<br>
+<br>
+
+
+# Contributing
+* Ideas/Problems - Please create an issue on Github or find an existing thread. We want to make Garry's Mod addon development easier for you!
+* Code
+    * Clone this repository and open it in VS Code
+    * Open a terminal and run `npm install`
+    * To debug, press `F5`. This will open a new window with the extension running.
+        * Use `ctrl+r` to reload the window
+
+
+# Resources
+* Icons
+    * [Font Awesome](https://fontawesome.com/icons/list)
+    * [Azure Functions Extension](https://github.com/microsoft/vscode-azurefunctions)
+    * [VS Code Extension Examples](https://github.com/microsoft/vscode-extension-samples/)
+    * [Garry's Mod Logo](https://icons8.com/icons/set/garrys-mod)