Skip to content

Commit 7e8f92a

Browse files
author
Bradley A. Thornton
authored
Merge pull request #5 from ansible-network/bt_update_readme
Add to readme.md
2 parents 83d51d1 + fe4be68 commit 7e8f92a

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
1-
## Resource module models and scaffolder
1+
## Resource module builder
22

3-
### To do
3+
### Overview
44

5-
1) Improve the model schema
6-
2) Add the example files to the doc string
7-
3) Document the model keys
5+
The resource module builder is an Ansible playbook that helps developers scaffold and maintain an Ansible network resource modules.
6+
7+
**Capabilities**
8+
- Use a defined model to scaffold a resource module directory layout and initial class files.
9+
- Scaffold either an ansible role or collection.
10+
- Subsequent uses of RMB will only replace the module arspec and file containing the module doc string.
11+
- Complex examples can be stored along side the model in the same directory
12+
- Maintain the model as the source of truth for the module and use RMB to update the source files as needed.
813

914

1015
### Usage

0 commit comments

Comments
 (0)