README.md in testlab-0.3.1 vs README.md in testlab-0.4.0
- old
+ new
@@ -4,16 +4,32 @@
[](https://coveralls.io/r/zpatten/testlab)
[](https://codeclimate.com/github/zpatten/testlab)
# TestLab
-A framework for building lightweight virtual infrastructure using LXC
+What is TestLab? TestLab lets you iterate virtual infrastructure quickly. Using a `Labfile` you can define how you want your virtual infrastructure laid out. You can define multiple network segments and containers (i.e. boxen). TestLab will then setup and teardown this virtual infrastructure as you have dictated in the `Labfile`.
+TestLab can be run directly on the command-line or can be interfaced with directly via code. Unlike the trend with some popular open-source software recently, I want you to build off this API interface and hopefully create tools I would of never dreamed up.
+
+Accessing TestLab via code is meant to be fairly easy and straightforward. To get an instance of TestLab you only need about four lines of code:
+
+ log_file = File.join(Dir.pwd, "testlab.log")
+ @logger = ZTK::Logger.new(log_file)
+ @ui = ZTK::UI.new(:logger => @logger)
+ @testlab = TestLab.new(:ui => @ui)
+
+Calling `TestLab.new` without a `:labfile` option will, by default, attempt to read `Labfile` from the current directory. This behaviour can be changed by passing the `:labfile` key with a path to your desired "Labfile" as the value to your `TestLab.new`.
+
+For more information see the TestLab Documentation, `testlab-repo`, command-line binary and it never hurts to look at the TestLab source itself.
+
# REQUIREMENTS
* Latest VirtualBox Package
* Latest Vagrant Package (non-gem version)
+* Ubuntu 13.04 Recommended; 12.10 Minimum
+
* Ubuntu 13.04 Server 64-bit (Raring) Base Box - https://github.com/zpatten/raring64
+* Ubuntu 12.10 Server 64-bit (Quantal) Base Box - https://github.com/zpatten/quantal64
# EXAMPLE USE
* See the `testlab-repo` - https://github.com/zpatten/testlab-repo