Merge pull request #5 from bleech/update-readme

feat(READMEs): Updated READMEs to the latest README code standard

generators/app/templates/Components/README.md

@@ -1,15 +1,57 @@
-Title: <%= elementName %>
+## <%= elementName %> README
 
-----
+### Title:
 
-Category: YourCategory
+<%= elementName %>
 
-----
+---
 
-Tags: tag1, tag2, tag3
+### Category: 
 
-----
+Select one of :
+Accordion / Calendar / Form / Hero / Map / Modal / Navigation / Sidebar / Slider / Table / Tabs
 
-Text: Add a small description for your component here. Explain what it does and what kind of options are supported.
+Or if none of the above are relevant select: 
+Block / Document / Grid /Layout / List
 
-### Add more notes down here
+---
+
+### Tags: 
+
+Comma separated list of tags relating to the component. 
+
+---
+
+### Description: 
+
+Brief description of what the component is, keep this as brief as possible but detailed enough that anyone on the project could pick up the component and complete it without your input. 
+
+---
+
+### Fields: 
+
+What fields need to be defined for this component? Just a list of field names, no need for actual field definitions in the README.md
+
+---
+
+### Internal Dependencies: 
+
+Does this component depend on any global fields or other modules? 
+
+---
+
+### External Dependencies:
+
+Does this component depend on any external deliveries, system, APIs, etc.?
+
+---
+
+### Potential Challenges/Learnings:
+
+At this point what are you concerned about in the component? What might be the issues that you will come across, what think do you need to do before the you start the component?
+
+When the module is completed please update this section to outline any learning point you might have had during the development. Write them in a way that will help someone building a similar component in the future 
+
+* What would you start doing?
+* What would you stop doing?
+* What would you continue doing?

generators/app/templates/Features/README.md

@@ -1,3 +1,47 @@
-# <%= elementName %> (Flynt Feature)
+## <%= elementName %> Feature README
 
-Add your features description here so other developers can understand your feature.
+### Title:
+
+<%= elementName %>
+
+---
+
+### Tags: 
+
+Comma separated list of tags relating to the feature.
+
+---
+
+### Description: 
+
+Brief description of what the component is, keep this as brief as possible but detailed enough that anyone on the project could pick up the component and complete it without your input.
+
+---
+
+### Fields:
+
+What fields need to be defined for this component? Just a list of field names, no need for actual field definitions in the README.md
+
+---
+
+### Internal Dependencies:
+
+Does this component depend on any global fields or other modules?
+
+---
+
+### External Dependencies:
+
+Does this component depend on any external deliveries, system, APIs, etc.?
+
+---
+
+### Potential Challenges/Learnings:
+
+At this point what are you concerned about in the component? What might be the issues that you will come across, what think do you need to do before the you start the component?
+
+When the module is completed please update this section to outline any learning point you might have had during the development. Write them in a way that will help someone building a similar component in the future 
+
+* What would you start doing?
+* What would you stop doing?
+* What would you continue doing?