aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--README.md64
1 files changed, 63 insertions, 1 deletions
diff --git a/README.md b/README.md
index eabbd3f..1bd1668 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,63 @@
1# terraform-provider-mailgun \ No newline at end of file 1Terraform Provider Mailgun
2==================
3
4- Website: https://www.terraform.io
5- [![Gitter chat](https://badges.gitter.im/hashicorp-terraform/Lobby.png)](https://gitter.im/hashicorp-terraform/Lobby)
6- Mailing list: [Google Groups](http://groups.google.com/group/terraform-tool)
7
8<img src="https://cdn.rawgit.com/hashicorp/terraform-website/master/content/source/assets/images/logo-hashicorp.svg" width="600px">
9
10Requirements
11------------
12
13- [Terraform](https://www.terraform.io/downloads.html) 0.10.x
14- [Go](https://golang.org/doc/install) 1.12 (to build the provider plugin)
15
16Building The Provider
17---------------------
18
19Clone repository to: `$GOPATH/src/github.com/fretlink/terraform-provider-mailgun`
20
21```sh
22$ mkdir -p $GOPATH/src/github.com/fretlink; cd $GOPATH/src/github.com/fretlink
23$ git clone git@github.com:fretlink/terraform-provider-mailgun
24```
25
26Enter the provider directory and build the provider
27
28```sh
29$ cd $GOPATH/src/github.com/fretlink/terraform-provider-mailgun
30$ make build
31```
32
33Using the provider
34----------------------
35## Fill in for each provider
36
37Developing the Provider
38---------------------------
39
40If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (version 1.12+ is *required*). You'll also need to correctly setup a [GOPATH](http://golang.org/doc/code.html#GOPATH), as well as adding `$GOPATH/bin` to your `$PATH`.
41
42To compile the provider, run `make build`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
43
44```sh
45$ make bin
46...
47$ $GOPATH/bin/terraform-provider-mailgun
48...
49```
50
51In order to test the provider, you can simply run `make test`.
52
53```sh
54$ make test
55```
56
57In order to run the full suite of Acceptance tests, run `make testacc`.
58
59*Note:* Acceptance tests create real resources, and often cost money to run.
60
61```sh
62$ make testacc
63```