Skip to content

Commit cba6842

Browse files
committed
Update README with terraform registry link
1 parent 964eca3 commit cba6842

File tree

3 files changed

+6
-138
lines changed

3 files changed

+6
-138
lines changed

README.md

+6-41
Original file line numberDiff line numberDiff line change
@@ -2,38 +2,10 @@
22

33
This provider is used to configure resources supported by the [HireFire API].
44

5-
[HireFire API]: https://docs.hirefire.io/
6-
7-
8-
Install
9-
---
10-
11-
Download from [releases] page and install in [Terraform's plugin directory].
12-
13-
The [install.sh] script will do this for you. Download the file, change `x.x.x`
14-
to the latest version, and run it like:
15-
16-
./install.sh x.x.x
17-
18-
Then subscribe to Releases only notifications to be alerted of new releases.
19-
20-
[releases]: https://github.com/carwow/terraform-provider-hirefire/releases
21-
[Terraform's plugin directory]: https://www.terraform.io/docs/configuration/providers.html#third-party-plugins
22-
[install.sh]: https://github.com/carwow/terraform-provider-hirefire/blob/master/install.sh
5+
Documention at [Terraform registry].
236

24-
25-
Usage
26-
---
27-
28-
provider "hirefire" {
29-
version = "~> 0.1"
30-
api_key = "your-key" // or set environment variable HIREFIRE_API_KEY
31-
}
32-
33-
For resources documentation, see the code under [resources] directory, and
34-
consult the [HireFire API] documenation for more details.
35-
36-
[resources]: https://github.com/carwow/terraform-provider-hirefire/tree/master/resources
7+
[HireFire API]: https://docs.hirefire.io/
8+
[Terraform registry]: https://registry.terraform.io/providers/carwow/hirefire/latest/docs
379

3810

3911
Development
@@ -80,17 +52,10 @@ or to run tests for a single resource:
8052
Release
8153
---
8254

83-
Change `x.x.x` to the appropriate version, and build the binaries by running:
84-
85-
rake release[x.x.x]
86-
87-
If you have GitHub's [hub] command, a GitHub release will be created for you.
88-
Otherwise, create the GitHub release.
89-
90-
Then upload the binaries to the GitHub release. You **always** need to upload
91-
the binaries, even if the release was created by hub.
55+
1. Update version in [docs/index.md] if necessary and commit.
56+
2. Push a tag for the new version. CircleCI will do the rest.
9257

93-
[hub]: https://github.com/github/hub
58+
[docs/index.md]: https://github.com/carwow/terraform-provider-hirefire/blob/master/docs/index.md
9459

9560

9661
Contributing

Rakefile

-53
This file was deleted.

install.sh

-44
This file was deleted.

0 commit comments

Comments
 (0)