Release readme update (#204)

Author: RJ Lohan

README.md

@@ -1,23 +1,37 @@
 ## AWS CloudFormation Resource Provider Java Plugin
 
+The CloudFormation CLI (cfn) allows you to author your own resource providers that can be used by CloudFormation.
 
-The CloudFormation Resource Provider Development Kit (RPDK) allows you to author your own resource providers that can be used by CloudFormation.
+This plugin library helps to provide Java runtime bindings for the execution of your providers by CloudFormation.
 
-This plugin library helps to provide runtime bindings for the execution of your providers by CloudFormation.
+Usage
+-----
+
+If you are using this package to build resource providers for CloudFormation, install the (CloudFormation CLI)[https://github.com/aws-cloudformation/aws-cloudformation-rpdk] and the (CloudFormation CLI Java Plugin)[https://github.com/aws-cloudformation/aws-cloudformation-rpdk-java-plugin]
+
+```
+pip install cloudformation-cli
+pip install cloudformation-cli-java-plugin
+```
+
+Refer to the documentation for the [CloudFormation CLI](https://github.com/aws-cloudformation/aws-cloudformation-rpdk) for usage instructions.
 
 Development
 -----------
 
-For changes to the plugin, a Python virtual environment is recommended. You also need to download `aws-cloudformation-rpdk` and install it first, as it isn't currently available on PyPI, but is a required dependency:
+First, you will need to install the (CloudFormation CLI)[https://github.com/aws-cloudformation/aws-cloudformation-rpdk], as it is a required dependency:
+
+```
+pip install cloudformation-cli
+```
+
+For changes to the plugin, a Python virtual environment is recommended.
 
 ```
 python3 -m venv env
 source env/bin/activate
-# assuming aws-cloudformation-rpdk has already been cloned/downloaded
-pip install \
-    -e ../aws-cloudformation-rpdk \
-    -r ../aws-cloudformation-rpdk/requirements.txt \
-    -e .
+# assuming cloudformation-cli has already been cloned/downloaded
+pip install -e .
 pre-commit install
 ```
 

README.rst

@@ -0,0 +1,65 @@
+AWS CloudFormation Resource Provider Java Plugin
+================================================
+
+The CloudFormation CLI (cfn) allows you to author your own resource
+providers that can be used by CloudFormation.
+
+This plugin library helps to provide Java runtime bindings for the
+execution of your providers by CloudFormation.
+
+Usage
+-----
+
+If you are using this package to build resource providers for
+CloudFormation, install the (CloudFormation
+CLI)[https://github.com/aws-cloudformation/aws-cloudformation-rpdk] and
+the (CloudFormation CLI Java
+Plugin)[https://github.com/aws-cloudformation/aws-cloudformation-rpdk-java-plugin]
+
+.. code-block:: bash
+
+   pip install cloudformation-cli
+   pip install cloudformation-cli-java-plugin
+
+Refer to the documentation for the `CloudFormation CLI`_ for usage
+instructions.
+
+Development
+-----------
+
+First, you will need to install the (CloudFormation
+CLI)[https://github.com/aws-cloudformation/aws-cloudformation-rpdk], as
+it is a required dependency:
+
+.. code-block:: bash
+
+   pip install cloudformation-cli
+
+For changes to the plugin, a Python virtual environment is recommended.
+
+.. code-block:: bash
+
+   python3 -m venv env
+   source env/bin/activate
+   # assuming cloudformation-cli has already been cloned/downloaded
+   pip install -e .
+   pre-commit install
+
+Linting and running unit tests is done via `pre-commit`_, and so is
+performed automatically on commit. The continuous integration also runs
+these checks. Manual options are available so you don't have to commit):
+
+.. code-block:: bash
+
+   # run all hooks on all files, mirrors what the CI runs
+   pre-commit run --all-files
+   # run unit tests only. can also be used for other hooks, e.g. black, flake8, pylint-local
+   pre-commit run pytest-local
+
+License
+-------
+
+This library is licensed under the Apache 2.0 License.
+
+.. _CloudFormation CLI: https://github.com/aws-cloudformation/aws-cloudformation-rpdk
+.. _pre-commit: https://pre-commit.com/

buildspec.yml

@@ -17,12 +17,6 @@ phases:
       - cd "$WD"
   build:
     commands:
-      # install aws-cloudformation-resource-schema
-      - cd "$CODEBUILD_SRC_DIR_SCHEMA"
-      - >
-        mvn verify org.apache.maven.plugins:maven-install-plugin:3.0.0-M1:install
-        --batch-mode
-        --no-transfer-progress
       # install aws-cloudformation-rpdk-java-plugin and rpdk core
       - cd "$CODEBUILD_SRC_DIR"
       - >