little readme

README.md

@@ -1,4 +1,20 @@
-# threadloop
+# ThreadLoop
 
 [![Build Status](https://travis-ci.org/breerly/threadloop.svg?branch=master)](https://travis-ci.org/breerly/threadloop) [![Coverage Status](https://coveralls.io/repos/breerly/threadloop/badge.svg)](https://coveralls.io/r/breerly/threadloop)
 
+> Run Tornado Coroutines from Synchronous Python.
+
+```python
+
+from threadloop import ThreadLoop
+from tornado import gen
+
+@gen.coroutine
+def hello(greeting="Goodbye"):
+    raise gen.Result("%s World" % greeting)
+
+with ThreadLoop() as threadloop:
+    future = threadloop.submit(hello, "Hello")
+
+    print future.result() # Hello World
+```

threadloop/threadloop.py

@@ -60,10 +60,10 @@ def stop(self):
         self.io_loop.stop()
         self.thread.join()
 
-    def submit(self, coroutine, *args, **kwargs):
+    def submit(self, fn, *args, **kwargs):
         """Submit Tornado Coroutine to IOLoop in daemonized thread.
 
-        :param coroutine: Tornado Coroutine to execute
+        :param fn: Tornado Coroutine to execute
         :param args: Args to pass to coroutine
         :param kwargs: Kwargs to pass to coroutine
         :returns concurrent.futures.Future: future result of coroutine
@@ -80,7 +80,7 @@ def on_done(tornado_future):
                 future.set_result(tornado_future.result())
 
         self.io_loop.add_callback(
-            lambda: coroutine(*args, **kwargs).add_done_callback(on_done)
+            lambda: fn(*args, **kwargs).add_done_callback(on_done)
         )
 
         return future