From db0e3d0a1eed7db734429f32266a11216f72742b Mon Sep 17 00:00:00 2001 From: Alexandre Garand Date: Thu, 4 Jul 2019 15:47:35 +0200 Subject: [PATCH] add README --- README.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 63 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eabbd3f..f3c5b60 100644 --- a/README.md +++ b/README.md @@ -1 +1,63 @@ -# terraform-provider-mailgun \ No newline at end of file +Terraform Provider +================== + +- Website: https://www.terraform.io +- [![Gitter chat](https://badges.gitter.im/hashicorp-terraform/Lobby.png)](https://gitter.im/hashicorp-terraform/Lobby) +- Mailing list: [Google Groups](http://groups.google.com/group/terraform-tool) + + + +Requirements +------------ + +- [Terraform](https://www.terraform.io/downloads.html) 0.10.x +- [Go](https://golang.org/doc/install) 1.12 (to build the provider plugin) + +Building The Provider +--------------------- + +Clone repository to: `$GOPATH/src/github.com/fretlink/terraform-provider-mailgun` + +```sh +$ mkdir -p $GOPATH/src/github.com/fretlink; cd $GOPATH/src/github.com/fretlink +$ git clone git@github.com:fretlink/terraform-provider-mailgun +``` + +Enter the provider directory and build the provider + +```sh +$ cd $GOPATH/src/github.com/fretlink/terraform-provider-mailgun +$ make build +``` + +Using the provider +---------------------- +## Fill in for each provider + +Developing the Provider +--------------------------- + +If 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`. + +To compile the provider, run `make build`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory. + +```sh +$ make bin +... +$ $GOPATH/bin/terraform-provider-mailgun +... +``` + +In order to test the provider, you can simply run `make test`. + +```sh +$ make test +``` + +In order to run the full suite of Acceptance tests, run `make testacc`. + +*Note:* Acceptance tests create real resources, and often cost money to run. + +```sh +$ make testacc +``` -- 2.41.0