From 46afe65aec8a668a30b9bad06e5dd43be88f2c77 Mon Sep 17 00:00:00 2001
From: Callum Axon <callumaxon@gmail.com>
Date: Sat, 23 May 2020 14:42:18 +0100
Subject: [PATCH] docs(setup): add docs for project setup and deployment

---
 .nvmrc    |  1 +
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++------
 2 files changed, 51 insertions(+), 6 deletions(-)
 create mode 100644 .nvmrc

diff --git a/.nvmrc b/.nvmrc
new file mode 100644
index 0000000..c92af7f
--- /dev/null
+++ b/.nvmrc
@@ -0,0 +1 @@
+13.5.0
\ No newline at end of file
diff --git a/README.md b/README.md
index 96594a9..7d0acc2 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,68 @@
 # consilio
 
+UI Kit for VATSIM UK Services.
+
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+
+This project provides:
+
+- Common CSS styles using Tailwind CSS w/ custom config
+- Color pallete & spacing standards
+- Common Vue components to be used in projects as a package.
+
 ## Project setup
+
+It is suggested to use Node Version Manager.
+To select the supported version of node for the project, run `nvm use`
+and the `.nvmrc` file in the root of the project will tell node which version to use.
+
+After this, the dependencies can be installed.
+
 ```
 yarn install
 ```
 
-### Compiles and hot-reloads for development
+## To setup a playground for development
+
 ```
-yarn serve
+cp src/Playground.example.vue src/Playground.vue
 ```
 
-### Compiles and minifies for production
+This will copy the Playground.vue component to be used.
+
+Start the playground
+
 ```
-yarn build
+yarn run playground
 ```
 
+Insert any component you are working on into this file. Any changes are set to be ignored by default so don't worry about committing any of these changes.
+
 ### Lints and fixes files
+
+The repository is setup to automatically lint your files on save.
+Should it not do this, run the following command to activate the linting.
+
 ```
 yarn lint
 ```
 
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+## Committing to repository
+
+This repo is [commitizen-friendly](https://github.com/commitizen/cz-cli).
+Each commit must be made via commitizen style commit. This can be activated by running to activate the commitizen menu.
+
+```
+git cz or yarn commit
+```
+
+## Deployment steps
+
+Before deploying, ensure logged into the package registry with a token which allows pushing to the registry.
+
+1. Ensure all changes are present on master
+2. Run `yarn publish --new-version=<VERSION>` to generate a
+   changelog, generate relevant git tag and publish to the package registry
+3. Run `git push origin --tags` to publish the git tag to the repository
+
+This will now have published the package to the registry.