[ALOY-92] Go through all GitHub ReadMe files and make sure content is accurate and descriptive, snippets of code is helpful.
| GitHub Issue | n/a |
|---|---|
| Type | Story |
| Priority | High |
| Status | Resolved |
| Resolution | Fixed |
| Resolution Date | 2012-08-06T10:55:21.000+0000 |
| Affected Version/s | n/a |
| Fix Version/s | 2012 Sprint 15, Release 3.0.0 |
| Components | XML |
| Labels | n/a |
| Reporter | Russell McMahon |
| Assignee | Unknown |
| Created | 2012-07-16T19:30:35.000+0000 |
| Updated | 2018-03-07T22:25:38.000+0000 |
1) Update install section to talk about platform issues like the pre-release is only for mac-osx and there are path issues with non default installs of node and npm. Inline provide possible fixes 2) Add a debug section describing that breakpoint can be added to components but a debugger is in the works. 3) In the goals section add as much real detail as possible as to benefits like reduces code by x percent
@Russ I noticed in the README that the link in this line "See the *Widget Example* for an example of building and using a widget." links to a 404 page.