From 8a1276c81717b908ac1aa4f5a4a1415d3cd3a5d7 Mon Sep 17 00:00:00 2001
From: Marcus Weiner <marcus.weiner@gmail.com>
Date: Sat, 20 Jul 2024 20:42:19 +0200
Subject: [PATCH] Update readme

---
 README.md | 57 +++++++++++++++++++++++--------------------------------
 1 file changed, 24 insertions(+), 33 deletions(-)

diff --git a/README.md b/README.md
index 9759acd..7b224d8 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,36 @@
-# Terraform Provider Scaffolding (Terraform Plugin Framework)
+# Netbox BGP Plugin Terraform Provider
 
-_This template repository is built on the [Terraform Plugin Framework](https://github.com/hashicorp/terraform-plugin-framework). The template repository built on the [Terraform Plugin SDK](https://github.com/hashicorp/terraform-plugin-sdk) can be found at [terraform-provider-scaffolding](https://github.com/hashicorp/terraform-provider-scaffolding). See [Which SDK Should I Use?](https://developer.hashicorp.com/terraform/plugin/framework-benefits) in the Terraform documentation for additional information._
+This provider allows managing BGP resources in Netbox, when the [Netbox BGP plugin](https://github.com/netbox-community/netbox-bgp) is installed.
 
-This repository is a *template* for a [Terraform](https://www.terraform.io) provider. It is intended as a starting point for creating Terraform providers, containing:
+The provider is intentionally using a similar structure to the [`e-breuninger/netbox`](https://registry.terraform.io/providers/e-breuninger/netbox/latest) provider. If you're already using that provider, this provider should work smoothly alongside it.
 
-- A resource and a data source (`internal/provider/`),
-- Examples (`examples/`) and generated documentation (`docs/`),
-- Miscellaneous meta files.
+## Configure
 
-These files contain boilerplate code that you will need to edit to create your own Terraform provider. Tutorials for creating Terraform providers can be found on the [HashiCorp Developer](https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework) platform. _Terraform Plugin Framework specific guides are titled accordingly._
+Example configuration:
 
-Please see the [GitHub template repository documentation](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) for how to create a new repository from this template on GitHub.
+```tf
+provider "netboxbgp" {
+  server_url = "https://netbox.my-company.net"
+  api_token  = var.netbox_api_token
+}
+```
+
+You can also set the provider config from environment variables:
+
+- `NETBOX_SERVER_URL` in place of `server_url`
+- `NETBOX_API_TOKEN` in place of `api_token`
+
+For more details and additional properties, see [the docs](./docs/index.md).
 
-Once you've written your provider, you'll want to [publish it on the Terraform Registry](https://developer.hashicorp.com/terraform/registry/providers/publishing) so that others can use it.
+## Development
 
-## Requirements
+### Requirements
 
 - [Terraform](https://developer.hashicorp.com/terraform/downloads) >= 1.0
-- [Go](https://golang.org/doc/install) >= 1.21
+- [Go](https://golang.org/doc/install) >= 1.22
+- [Docker](https://docs.docker.com/desktop/)
 
-## Building The Provider
+### Building The Provider
 
 1. Clone the repository
 1. Enter the repository directory
@@ -29,25 +40,7 @@ Once you've written your provider, you'll want to [publish it on the Terraform R
 go install
 ```
 
-## Adding Dependencies
-
-This provider uses [Go modules](https://github.com/golang/go/wiki/Modules).
-Please see the Go documentation for the most up to date information about using Go modules.
-
-To add a new dependency `github.com/author/dependency` to your Terraform provider:
-
-```shell
-go get github.com/author/dependency
-go mod tidy
-```
-
-Then commit the changes to `go.mod` and `go.sum`.
-
-## Using the provider
-
-Fill this in for each provider
-
-## Developing the 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 (see [Requirements](#requirements) above).
 
@@ -57,8 +50,6 @@ To generate or update documentation, run `go generate`.
 
 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.
-
 ```shell
 make testacc
 ```