Version 0.5-beta readme and changes

Author: elizarov

CHANGES.md

@@ -1,4 +1,17 @@
-# kotlinx.coroutines change log
+# Change log for kotlinx.coroutines 
+
+## Version 0.5-beta
+
+* Switched to Kotlin version 1.1.0-beta-22 (republished version).
+* Removed `currentCoroutineContext` and related thread-locals without replacement.
+  Explicitly pass coroutine context around if needed.
+* `lazyDefer(context) {...}` coroutine builder and `LazyDeferred` interface are introduced.
+* The default behaviour of all coroutine dispatchers is changed to always schedule execution of new coroutine 
+  for later in this thread or thread pool. Correspondingly, `CoroutineDispatcher.isDispatchNeeded` function
+  has a default implementation that returns `true`.
+* `NonCancellable` context is introduced.  
+* Performance optimizations for cancellable continuations (fewer objects created).
+* A [guide on coroutines](coroutines-guide.md) is added.  
 
 ## Version 0.4-beta
 

README.md

@@ -1,18 +1,20 @@
 # kotlinx.coroutines
 
-Library support for Kotlin coroutines. This is a companion version for Kotlin 1.1.0-beta-18 release. 
+Library support for Kotlin coroutines. This is a companion version for Kotlin 1.1.0-beta-22 release. 
 
 ## Modules and features
 
 * `kotlinx-coroutines-core` module with core primitives to work with coroutines. It is designed to work on any JDK6+ and Android
 and contains the following main pieces:
-  * `launch(context) { ... }` to start a coroutine in the given context and get reference to its `Job`.
-  * `run(context) { ... }` to switch to a different context inside a coroutine.
-  * `runBlocking { ... }` to use asynchronous Kotlin APIs from a thread-blocking code.  
-  * `defer(context) { ... }` to get a deferred result of coroutine execution in a non-blocking way
-     via a light-weight future interface called `Deferred`.
-  * `delay(...)` for a non-blocking sleep in coroutines.
-  * `CommonPool` and `Here` contexts, `context` or a parent coroutine.
+  * `launch(context) {...}` to start a coroutine in the given context and get reference to its `Job`.
+  * `run(context) {...}` to switch to a different context inside a coroutine.
+  * `runBlocking {...}` to use asynchronous Kotlin APIs from a thread-blocking code.  
+  * `defer(context) {...}` and `lazyDefer(context) {...}` to get a deferred result of coroutine execution in a 
+     non-blocking way via a light-weight future interface called `Deferred`.
+  * `delay(...)` for a non-blocking sleep in coroutines and `yield` to release a thread in single-threaded dispatchers.
+  * `withTimeout(timeout) {...}` scope function to easily set coroutine time-limit (deadline),
+     and `NonCancellable` context to avoid it when needed.
+  * `CommonPool` and `Here` contexts, access to `context` of a parent coroutine in its `CoroutineScope`.
   * `newSingleThreadContext(...)` and `newFixedThreadPoolContext(...)` functions, 
     `Executor.toCoroutineDispatcher()` extension.
   * Cancellation support with `Job` interface and `suspendCancellableCoroutine` helper function.
@@ -36,9 +38,9 @@ from inside coroutines. It is in very basic form now (example-only, not even clo
 
 ## References and documentation
 
-* [Coroutines guide](coroutines-guide.md) 
-* [Change log](CHANGES.md)
-* [Coroutines design document](https://github.com/Kotlin/kotlin-coroutines/blob/master/kotlin-coroutines-informal.md)
+* [Guide to kotlinx.coroutines by example](coroutines-guide.md) 
+* [Change log for kotlinx.coroutines](CHANGES.md)
+* [Coroutines design document (KEEP)](https://github.com/Kotlin/kotlin-coroutines/blob/master/kotlin-coroutines-informal.md)
 
 ## Using in your projects
 
@@ -79,7 +81,7 @@ And make sure that you use the right Kotlin version:
 
 ```xml
 <properties>
-    <kotlin.version>1.1.0-beta-18</kotlin.version>
+    <kotlin.version>1.1.0-beta-22</kotlin.version>
 </properties>
 ```
 
@@ -105,6 +107,6 @@ And make sure that you use the right Kotlin version:
 
 ```groovy
 buildscript {
-    ext.kotlin_version = '1.1.0-beta-18'
+    ext.kotlin_version = '1.1.0-beta-22'
 }
 ```

pom.xml

@@ -7,7 +7,7 @@
 
     <groupId>org.jetbrains.kotlinx</groupId>
     <artifactId>kotlinx-coroutines</artifactId>
-    <version>0.4-beta-SNAPSHOT</version>
+    <version>0.5-beta-SNAPSHOT</version>
     <packaging>pom</packaging>
 
     <name>Kotlin coroutines libraries</name>
@@ -61,7 +61,7 @@
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <kotlin.version>1.1.0-beta-18</kotlin.version>
+        <kotlin.version>1.1.0-beta-22</kotlin.version>
         <dokka.version>0.9.13</dokka.version>
         <junit.version>4.12</junit.version>
         <maven.compiler.source>1.6</maven.compiler.source>