Skip to content

Commit f62aefc

Browse files
RJ Lohantobywf
authored andcommitted
Updating README.md for release (#94)
1 parent d80dfcc commit f62aefc

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

README.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,54 @@
1-
## AWS CloudFormation RPDK Go Plugin
1+
## AWS CloudFormation Resource Provider Go Plugin
22

3-
The CloudFormation Provider Development Toolkit Go Plugin allows you to autogenerate Go code based on an input schema.
3+
The CloudFormation CLI (cfn) allows you to author your own resource providers that can be used by CloudFormation.
44

5-
This plugin library helps to provide runtime bindings for the execution of your providers by CloudFormation.
5+
This plugin library helps to provide Go runtime bindings for the execution of your providers by CloudFormation.
6+
7+
Usage
8+
-----
9+
10+
If you are using this package to build resource providers for CloudFormation, install the [CloudFormation CLI Go Plugin](https://github.com/aws-cloudformation/cloudformation-cli-go-plugin) - this will automatically install the the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli)! A Python virtual environment is recommended.
11+
12+
```bash
13+
pip3 install cloudformation-cli-go-plugin
14+
```
15+
16+
Refer to the documentation for the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli) for usage instructions.
617

718
Development
819
-----------
920

10-
For changes to the plugin, a Python virtual environment is recommended. You also need to download `cloudformation-cli` and install it first:
21+
For changes to the plugin, a Python virtual environment is recommended. Check out and install the plugin in editable mode:
1122

12-
```
23+
```bash
1324
python3 -m venv env
1425
source env/bin/activate
15-
pip3 install cloudformation-cli
16-
pip3 install -e .
26+
pip3 install -e /path/to/cloudformation-cli-go-plugin
1727
```
1828

19-
Linting and running unit tests is done via [pre-commit](https://pre-commit.com/), 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):
29+
You may also want to check out the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli) if you wish to make edits to that. In this case, installing them in one operation works well:
2030

31+
```bash
32+
pip3 install \
33+
-e /path/to/cloudformation-cli \
34+
-e /path/to/cloudformation-cli-go-plugin
2135
```
36+
37+
That ensures neither is accidentally installed from PyPI.
38+
39+
Linting and running unit tests is done via [pre-commit](https://pre-commit.com/), 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:
40+
41+
```bash
2242
# run all hooks on all files, mirrors what the CI runs
2343
pre-commit run --all-files
24-
# run unit tests only. can also be used for other hooks, e.g. black, flake8, pylint-local
44+
# run unit tests only. can also be used for other hooks, e.g. black, isort, pytest-local
2545
pre-commit run pytest-local
2646
```
2747

2848
Getting started
2949
---------------
3050

31-
This plugin create a sample golang project and requires golang 1.8 or above and [godep](https://golang.github.io/dep/docs/introduction.html). For more information on installing and setting up your Go environment, please visit the offial [Golang site](https://golang.org/).
51+
This plugin create a sample Go project and requires golang 1.8 or above and [godep](https://golang.github.io/dep/docs/introduction.html). For more information on installing and setting up your Go environment, please visit the official [Golang site](https://golang.org/).
3252

3353

3454
License

0 commit comments

Comments
 (0)