diff --git a/README b/README deleted file mode 100644 index 8bdb18b..0000000 --- a/README +++ /dev/null @@ -1,14 +0,0 @@ - -TwitterActors -============= - -A fork of Scala (originally, 2.7.7) actor library that partially relies on -java.util.concurrent.* classes to avoid some problems with Scala's built-in -copy of various concurrent classes. Notably, it is using BlockingQueue, -LinkedBlockingQueue, and TimeUnit from java.util.concurrent package instead of -their private copies. - -In order to use this library instead of Scala actor library, import -com.twitter.actors.* instead of scala.actors.*. - -Attila Szegedi <> diff --git a/README.markdown b/README.markdown new file mode 100644 index 0000000..efcabe8 --- /dev/null +++ b/README.markdown @@ -0,0 +1,22 @@ +TwitterActors +============= + +A fork of the actor library from Scala 2.7.7 that completely removes Scala's +built-in copies of `java.util.concurrent.*` classes and instead relies on +their original versions in the standard Java library, without any functional +changes. + +Why? +---- +The built-in copies are from an old version of the Doug Lea's public-domain +code. The Java runtimes ship with versions of the code that is kept +up-to-date, with bugs being fixed and code begin enhanced. Simply by upgrading +to a new Java runtime, the actor runtime will benefit from any improvements to +the concurrent classes. + +Usage +----- +In order to use this library instead of Scala actor library, import +`com.twitter.actors.*` instead of `scala.actors.*` in your code. + +Attila Szegedi <>