Merge branch 'master' of https://github.com/matthew-lake/Juliet

README.md

@@ -14,7 +14,24 @@ Though development is at an early stage, please feel free to give feedback or ad
 
 All code is released under the MIT license.
 
+## How to use
+
+Juliet is only a framework, and uses seperate course packages. An example is provided at [BasicSyntaxLesson](https://github.com/matthew-lake/BasicSyntaxLesson).
+
+To use, simply import the package:
+```
+using BasicSyntaxLesson
+```
+and start Juliet:
+```
+juliet()
+```
 
 ## Julia 0.5 Compatibility Issues
 
 Currently not of Juliet's dependencies work in Julia 0.5. I have reached out to their maintainers, but cannot guarantee speedy updates. Should they remain incompatible for too long after 0.5's launch, I will endevor to find or create replacements.
+
+## Notes on Tests and Coverage
+
+The Julia 0.5 tests are currently failing due to the issues described above, but the tests pass on 0.4 on Windows, Linux and Mac.
+Coverage is currently underreported because the major tests model real-user interaction by running a new process and piping input to it, then observing STDOUT. Unfortunately, Coveralls does not keep track of this.