Merge branch 'master' of https://github.com/moteus/lua-llthreads2

1 files changed, 11 insertions, 1 deletions

diff --git a/README.md b/README.md
index 22f2025..58e78eb 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,15 @@ This is full dropin replacement for [llthreads](https://github.com/Neopallium/lu
 * thread:start() has additional parameter which control in which thread child Lua VM will be destroyed
 * allow pass cfunctions to child thread (e.g. to initialize Lua state)
 
+##Thread start arguments
+| default | `detached` | `joinable` | join returns | child state closes by | gc calls | detach on |
+|:-------:|:--------:|:--------:|:------------:|:------------------:|:--------:|:---------:|
+|         |   false  |   false  | `true`       |    child           |  join    | `<NEVER>` |
+|   *     |   false  |   true   | Lua values   |    parent          |  join    | `<NEVER>` |
+|   *     |   true   |   false  | raise error  |    child           | `<NONE>` |  start    |
+|         |   true   |   true   | `true`       |    child           | detach   |   gc      |
+
+
 ##Usage
 
 ### Use custom logger
@@ -45,7 +54,8 @@ local thread = require "llthreads".new[[
 
 -- We tell that we start attached thread but child Lua State shuld be close in child thread. 
 -- If `thread` became garbage in main thread then finallizer calls thread:join() 
--- and main thread may hungup.
+-- and main thread may hungup. But because of child state closes in child thread all objects
+-- in this state can be destroyed and we can prevent deadlock.
 thread:start(false, false)
 
 -- We can call join.