Updated: Examples, Requirements

README.md

@@ -2,18 +2,33 @@
 
 Tool to help you create templated READMEs that contain the actual information from your Terraform Module. Iterates through your module folder and pick up all information needed to make your README look good and provide helpful content.
 
-**NOTE:** Early stage of development, anyway it can fetch the most basic (and most time consuming) information from your module to create a README.
-
-## TODOs
-
-- Create better Makefile to make testing/development easier
-- Create Unit Tests
-- Create GitHub Action to run tests against Unit Tests
-- ~~Add support for multi line variables~~
-- ~~Add support for versions~~
-- Provide sample code for module in README
-- Choose between different README templates
-- Collect information about resources deployed and add to list
-- Create GitHub Action to use this tool
-- Create Actual README for repository
-- ~~REFACTOR~~
+Take a look at the examples folder to see some READMEs generated by this tool.
+ 
+
+## Requirements
+| Software | Version   |
+| :------- | :-------- |
+| Python   | >= 3.7    |
+| Pip3	   | >= 20.0.2 |
+| Terraform| >= 0.14.0 |
+ 
+
+**NOTE:** Older versions may work too, but aren't tested.
+
+## Examples
+ 
+
+Creates a README with all features for the Terraform module at given path.
+```
+python3 main.py --path "terraform-example-module/"
+```
+ 
+
+Creates a README excluding contributions for the Terraform module at given path and specifys title name.
+```
+python3 main.py --path "terraform-exaple-module" --name "Example Module" --contributing False
+```
+ 
+
+## Contributing
+Feel free to create pull requests.