xrm-datamigration icon indicating copy to clipboard operation
xrm-datamigration copied to clipboard

README needs refined

Open ewingjm opened this issue 5 years ago • 1 comments

Is your feature request related to a problem? Please describe.

I've noticed a couple of issues with the README that make it appear a little clumsy -

  • Installation section is talking about using the sample projects rather than installing the package - the section's content is also formatted more like Wiki than README content
  • The description header is superfluous
  • The table of contents has only one sub-section under Usage (Obfuscation)
  • Obfuscation is actually a header on the same level as Usage, rather than a sub-header as the ToC suggests
  • Usage instructs people to a create a new console app - this is overly prescriptive and not necessary
  • Obfuscation has its own sub-headers that aren't on the ToC
  • Contributing section should point to the CONTRIBUTING.md file
  • Credits section should probably be removed if we're just crediting ourselves

Describe the solution you'd like

  • Correct the installation section to be about installing the package (probably move the detail about the samples to the Wiki as it bloats the README)
  • Remove the description header and put the descriptive text under the title
  • Move obfuscation under usage and shift a considerable amount of this to the Wiki to avoid bloating the README with only specific features
  • Ensure the ToC is reflective of the actual headings
  • Replace the text in the Credits section with something along the lines of "Please refer to the Contributing guide." (with a link)
  • Remove the credits section

ewingjm avatar Dec 04 '20 17:12 ewingjm

  • add link(s) to XrmToolbox repo/tool.

tdashworth avatar Jan 20 '21 12:01 tdashworth