krisselden / ember-macro-benchmark

Benchmark recording of an ember app with running with 2 versions of Ember.
25 stars 9 forks source link

Documentation Request | Fleshed out ReadMe.md with a simple usage example #1

Open branden-thompson opened 7 years ago

branden-thompson commented 7 years ago

@krisselden -

SUMMARY

I have a slight documentation request - The install instructions seems simple enough, and I am planning to have our partner engineering teams use this as force function for Boyd-Cycling their decision making process (Observe / Verify , Orient, Decide, Act) when testing features or attempting performance optimizations.

OBJECTIVE

This documentation request will not be considered a waste of Kris Selden's time if we can provide enough bootstrapping documentation to prevent support requests covering basic usage of this benchmarking tool.

ACCEPTANCE CRITERIA

PRE-REQUISITES

rwjblue commented 7 years ago

Part of this is resolved (README is somewhat more fleshed out), but we should still add a few more usage examples / images...