diff --git a/README.md b/README.md index 89eb68e..aacda43 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,15 @@ Re-live datacenter performance firefights on your own desktop, installs in <5 mi What’s the problem? What’s the cause? The fix? Click click click. Done. Snail4j is a load-test-in-a-box that aims to educate all Java developers on software performance. +# Snail4j Intro + + +[Download/Install/Run doc](https://github.com/eostermueller/snail4j/wiki/Snail4j-Quickstart) - the "Quickstart" + +[Build wiki](https://github.com/eostermueller/snail4j/wiki/Build) + +[Contribute](https://github.com/eostermueller/snail4j/wiki/Contributing). + # Motivation Snail4j challenges the end user to [solicit predictions](https://blog.upperlinecode.com/stop-teaching-code-a1039983b39) on software performance experiments with main types of software defects: * Persistence @@ -18,9 +27,8 @@ Snail4j challenges the end user to [solicit predictions](https://blog.upperlinec * How much delay is required to slow down code with a sync block? # Goals -## Easy Install for Quick Meeting/Classroom/Conference Discussion -* <5 minute install -* Runs on MS-Win, Mac, and Linux -* Pure Java (and I guess browser) -* Optionally, just copy uber jar from USB stick, no internet access required. +* Quick and easy "[No Friction](https://github.com/eostermueller/snail4j/wiki/No-Friction-Distribution)" distribution. +* Provides self-paced, hands-on experience troubleshooting java performance. +* Great for a performance code review. +* Testing environment for any monitoring solution, to quickly test resource overhead of monitoring, confirm that monitoring can detect perf defects.