README updates - release notes

README.md

@@ -6,4 +6,51 @@ This repository contains a library of Jenkins Global Variables & Helper Variable
 
 Based on the following articles:
 - [How-To-Build-Your-Own-Jenkins-Shared-Library](https://itnext.io/how-to-build-your-own-jenkins-shared-library-9dc129db260c) 
-- [Unit-Testing-A-Jenkins-Shared-Library](https://itnext.io/unit-testing-a-jenkins-shared-library-9bfb6b599748)
+- [Unit-Testing-A-Jenkins-Shared-Library](https://itnext.io/unit-testing-a-jenkins-shared-library-9bfb6b599748)
+
+## Usage
+
+### Import Library
+
+As per the instructions on the [Jenkins Documentation], to include this library; in your `Jenkinsfile`:
+
+```groovy
+@Library('[email protected]') _
+```
+note that the name is the `id` of the Shared Library configured under Jenkins Configuration and the version after the `@` sign 
+can be `master` which points to the master branch of this library or simply omitted which would pick up the 
+default version configured under Jenkins Configuration (if you have it configured there).
+
+### Using Global Variables
+
+To use one of the global variables or helper variables defined in this library you just simply call it like the following examples.
+
+```groovy
+@Library('[email protected]') _
+buildJavaApp(repo: "name of repo")
+```
+
+```groovy
+@Library('[email protected]') _
+buildJavaAppDockerFull(repo: "name of repo", microserviceName: "example-app")
+```
+
+See under `vars/` to see list of full available Global Variables/Helper Variables to use.
+
+Alternatively, you can check out this example demo project which shows some use cases of this Shared Library:
+[Jenkins Pipelines](http://github.com/colinbut/jenkins-pipelines.git)
+
+## Release Notes
+
+__v1.0.0__
++ basic Global Variables (steps) to build:
+    + a Java App
+    + a full pipeline of building a Java App (from checkout to deployment)
++ Library classes to:
+    + build Docker Image
+    + Push Docker Image to AWS ECR (Elastic Container Registry) - AWS's Docker Registry
+    + basic Git helper commands
++ utilities
+    + logging
+    + notifications
++ Unit Tests using Jenkins-Spock