updating README

README.md

@@ -1 +1,39 @@
-# terraform-gcp-firewall-rules
+## Firewall-rules module for Google Cloud Platform
+
+Creates and manages Network Firewall rules on GCP
+
+**Basic usage**
+
+```hcl
+module firewall-module {
+  source = "/Users/Gabriel/Terraform/Terraform-registry/terraform-gcp-firewall-rules"
+  name = "ssh-rule"
+  network = "test-vpc"
+  protocol = "tcp"
+  ports = ["ssh"]
+  source_ranges = ["0.0.0.0/0"]
+  target_tags = [""]
+}
+```
+
+## Variables
+|Name|Description|Type|Default|Required|
+|----|-----------|:----:|:-------:|:--------:|
+|name|Name of the Firewall rule|String| - |Yes|
+|network|The name or self_link of the network to attach this firewall to|String| - |Yes|
+|source_ranges|A list of source CIDR ranges that this firewall applies to. Can't be used for EGRESS|List| - |No|
+|target_tags|A list of target tags for this firewall|List| - |No|
+|protocol|The name of the protocol to allow. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number, or all|String| - |Yes|
+|ports|List of ports and/or port ranges to allow. This can only be specified if the protocol is TCP or UDP|List| - |No|
+
+## Outputs
+
+|Name|Description|
+|----|-----------|
+|name|Subnetwork name|
+|self_link|The URI of the created resource|
+
+### Reference
+- [Terraform GCP Firewall](https://www.terraform.io/docs/providers/google/r/compute_firewall.html)
+- [Terraform Modules](https://www.terraform.io/docs/modules/usage.html)
+- [Terraform Interpolation](https://www.terraform.io/docs/configuration/interpolation.html)

variables.tf

@@ -13,7 +13,7 @@ variable "source_ranges" {
 
 variable "target_tags" {
   type = "list"
-  description = " A list of target tags for this firewall"
+  description = "A list of target tags for this firewall"
 }
 
 variable "protocol" {