code

GENERATING_MODULES.md

@@ -1,6 +1,6 @@
 # Generating Modules with pfsensible-generate-module
 
-The process of writing basic pfsensible modules is hopefully greately simplified by using
+The process of writing basic pfsensible modules is hopefully greatly simplified by using
 the pfsensible-generate-module script. The basic workflow is as follows:
 
 * Navigate in the pfSense web interface to the area you want to write a module for. This should be a page where you can edit
@@ -17,18 +17,20 @@ stops complaining about missing items.
 helpful to change as many options away from the default as possible. Focus on settings that would be useful to you.
 * Run the script:
 
- misc/pfsensible-generate-module --url URL
+        misc/pfsensible-generate-module --url URL
 
 if you needed to use different names for the items than "item_min" and "item_full" you can set them with the --item-min and
 --item-full options.
 
 ## Modules that configure something
 
-If this is a module that will just configure something, add the --is-config option.
+If this is a module that will just configure something, add the --is-config option:
+
+        misc/pfsensible-generate-module --url URL --is-config
 
 ## Other options
 
-* Pass the --author-name, --author-email, and --author-handle options.
+* Pass the --author-name, --author-email, and --author-handle options to give yourself credit!
 * You will need to add the --user and/or --password options if you have changed from the install defaults.
 * If the automatically determined module name does not seem correct, you can change it with the --module-name option.
 * It may make sense to create a module for different types of items if the parameters are wildly different (as is the case