Skip to content

Commit

Permalink
Improve README (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
mrolla authored Dec 7, 2018
1 parent e9f2014 commit 4bdd8b4
Showing 1 changed file with 20 additions and 14 deletions.
34 changes: 20 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# CircleCI terraform provider
# CircleCI Terraform provider

[![Build Status](https://circleci.com/gh/mrolla/terraform-provider-circleci.svg?style=shield)](https://circleci.com/gh/mrolla/terraform-provider-circleci.svg?style=shield) [![Go Report Card](https://goreportcard.com/badge/github.com/mrolla/terraform-provider-circleci)](https://goreportcard.com/badge/github.com/mrolla/terraform-provider-circleci)

- Website: https://www.terraform.io
- [![Gitter chat](https://badges.gitter.im/hashicorp-terraform/Lobby.png)](https://gitter.im/hashicorp-terraform/Lobby)
Expand All @@ -12,15 +14,21 @@
- [Go][go] 1.11 (to build the provider plugin)

## Using the provider
If you're building the provider, follow the instructions to [install it as a plugin.][install plugin].
After placing it into your plugins directory, run `terraform init` to initialize it.

[install plugin]: https://www.terraform.io/docs/plugins/basics.html#installing-a-plugin
[terraform]: https://www.terraform.io/downloads.html
[go]: https://golang.org/doc/install
#### Download a release
Download the latest release for your OS from the [release page][release page]
and follow the instructions to [install third party plugins][third party plugins].

#### Build from sources
To build the project you can use `make all` which will:
- run the tests (`make test`)
- build the binary (`make build`)
- copy the binary to the [Terraform plugin directory][third party plugins] (`make install_plugin_locally`)

After placing it into your plugins directory, run `terraform init` to initialize it.

## Example:

Example:
```hcl
provider "circleci" {
api_token = "${file("circleci_token")}"
Expand All @@ -35,10 +43,8 @@ resource "circleci_environment_variable" "from_terraform" {
}
```

## Contribute

To build the project you can use `make all` which:
1. run the tests `make test`
2. build the binary `make build`
3. copy the binary to the terraform plugin directory (default $HOME/.terraform.d/plugins/)
`make install_plugin_locally`
[install plugin]: https://www.terraform.io/docs/plugins/basics.html#installing-a-plugin
[third party plugins]: https://www.terraform.io/docs/configuration/providers.html#third-party-plugins
[terraform]: https://www.terraform.io/downloads.html
[go]: https://golang.org/doc/install
[release page]: https://github.com/mrolla/terraform-provider-circleci/releases

0 comments on commit 4bdd8b4

Please sign in to comment.