feat: add information on README.md

Author: task4233

README.md

@@ -1,3 +1,39 @@
 ## Terraform-Plugin-Framework-Demo
-This is demo for [Terraform-Plugin-Framework](https://www.terraform.io/docs/plugin/framework/) which is a new SDK under active development.
+This is an unofficial demo for [Terraform-Plugin-Framework](https://www.terraform.io/docs/plugin/framework/) which is a new SDK under active development.
 Further information might be in [Official GitHub Repository](https://github.com/hashicorp/terraform-plugin-framework).
+
+## How to use
+1. install plugin locally
+
+```bash
+$ make install
+```
+
+2. terraform init
+
+```bash
+cd examples
+terraform init
+```
+
+3. terraform apply(Create)
+
+```bash
+echo "running demo server for applying"
+go run ../demo-server/main.go
+terraform apply
+```
+
+4. terraform apply(Read)
+
+```bash
+terraform apply
+```
+
+5. terraform apply(Update)
+
+```bash
+echo "edit configuration in main.tf"
+vim main.tf
+terraform apply
+```

demo-server/main.go

@@ -11,7 +11,7 @@ import (
 
 	"github.com/go-chi/chi"
 	"github.com/go-chi/chi/middleware"
-	"github.com/task4233/note-v2-terraform/client"
+	"github.com/task4233/terraform-plugin-framework-demo/client"
 )
 
 const (

go.mod

@@ -1,4 +1,4 @@
-module github.com/task4233/note-v2-terraform
+module github.com/task4233/terraform-plugin-framework-demo
 
 go 1.17
 

log/provider.go

@@ -6,7 +6,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
 	"github.com/hashicorp/terraform-plugin-framework/types"
-	"github.com/task4233/note-v2-terraform/client"
+	"github.com/task4233/terraform-plugin-framework-demo/client"
 )
 
 // ref: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework@v0.4.2/tfsdk#Provider

log/resource_log.go

@@ -9,7 +9,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
 	"github.com/hashicorp/terraform-plugin-framework/types"
-	"github.com/task4233/note-v2-terraform/client"
+	"github.com/task4233/terraform-plugin-framework-demo/client"
 )
 
 type resourceLogType struct{}

main.go

@@ -4,7 +4,7 @@ import (
 	"context"
 
 	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
-	"github.com/task4233/note-v2-terraform/log"
+	"github.com/task4233/terraform-plugin-framework-demo/log"
 )
 
 func main() {