aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-11-28 01:15:44 +0100
committerMattias Andrée <maandree@operamail.com>2015-11-28 01:15:44 +0100
commitf2a5d378aa8c1197f11e159d62a9132d3dd27edf (patch)
tree8bcd0450c6e77955b06b60546005b623bf554acc
parentupdate join-python.pdf (diff)
downloadjoin-python-f2a5d378aa8c1197f11e159d62a9132d3dd27edf.tar.gz
join-python-f2a5d378aa8c1197f11e159d62a9132d3dd27edf.tar.bz2
join-python-f2a5d378aa8c1197f11e159d62a9132d3dd27edf.tar.xz
improve readme1.2
Signed-off-by: Mattias Andrée <maandree@operamail.com>
-rw-r--r--README24
1 files changed, 17 insertions, 7 deletions
diff --git a/README b/README
index 3c8da98..3a37396 100644
--- a/README
+++ b/README
@@ -1,12 +1,22 @@
-Join Python: Join-calculus for Python
+NAME
+ Join Python - Join-calculus for Python 3
-Extensions to join-calculus:
+DESCRIPTION
+ This library provides join-calculus to Python 3, with some extensions:
- concurrently(f...) runs a set of functions concurrently
- and joins with all of them.
+ * concurrently(f...) runs a set of functions concurrently and
+ joins with all of them.
- Signals have join() which joins with the signal and
- returns its return (signals do not need to be void.)
+ * Signals have join() which joins with the signal and returns
+ its return (signals do not need to be void.)
- The return of fragments are returned when fetching.
+ * The return of fragments are returned when fetching.
+
+RATIONALE
+ Join-calculus provides clean ways to perform asynchronous tasks.
+
+SEE ALSO
+ python(1), https://en.wikipedia.org/wiki/Join-calculus
+
+ Full documentation available locally via: info '(join-python)'