Skip to content

Commit 7325224

Browse files
committed
docs: Updated the README.
1 parent ff5fa12 commit 7325224

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

README.md

+57
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,60 @@ See the `docs/` directory for user-facing documentation.
2727
Don't reimplement things that already work well. This project leans on the following libraries:
2828

2929
* [chanced/caps](https://github.com/chanced/caps) — Handles the case manipulation.
30+
31+
## More Information
32+
33+
After the provider is installed, you can run `terraform-provider-corefunc` on the CLI.
34+
35+
* Install with either `terraform init` or `make build`.
36+
* The Go binary path (discovered by running `./find-go-bin.sh`) is on your `$PATH`.
37+
38+
This will display the following text:
39+
40+
```bash
41+
terraform-provider-corefunc
42+
```
43+
44+
```plain
45+
This binary is a plugin. These are not meant to be executed directly.
46+
Please execute the program that consumes these plugins, which will
47+
load any plugins automatically
48+
```
49+
50+
However, by passing the `--help` flag, you can see the other options available, including a description of the software.
51+
52+
```bash
53+
terraform-provider-corefunc --help
54+
```
55+
56+
The provider has one primary sub-command: `version`. It includes long-form version information, including the build commit hash, build date, Go version, and external dependencies.
57+
58+
```bash
59+
terraform-provider-corefunc version
60+
```
61+
62+
```plain
63+
BASIC
64+
Version: dev
65+
Go version: go1.21.1
66+
Git commit: 80ac4b1062bfeb81734e505f7fd977050bc4a3e9
67+
Dirty repo: true
68+
PGO: default.pgo
69+
Build date: 2023-09-24T23:50:26Z
70+
OS/Arch: darwin/arm64
71+
System: macOS on Apple Silicon
72+
CPU Cores: 10
73+
74+
DEPENDENCIES
75+
github.com/chanced/caps v1.0.1
76+
github.com/fatih/color v1.15.0
77+
github.com/golang/protobuf v1.5.3
78+
github.com/gookit/color v1.5.4
79+
github.com/hashicorp/go-hclog v1.5.0
80+
github.com/hashicorp/go-plugin v1.5.1
81+
github.com/hashicorp/go-uuid v1.0.3
82+
github.com/hashicorp/terraform-plugin-framework v1.4.0
83+
github.com/hashicorp/terraform-plugin-framework-validators v0.12.0
84+
github.com/hashicorp/terraform-plugin-go v0.19.0
85+
[...snip...]
86+
```

0 commit comments

Comments
 (0)