From e3fa59d0e538873b1964b51212d66853a0391772 Mon Sep 17 00:00:00 2001 From: Paul deGrandis Date: Tue, 4 Sep 2012 14:37:58 -0700 Subject: [PATCH 1/5] Update README.mkd --- README.mkd | 36 +++++++++++++++++++++++------------- 1 file changed, 23 insertions(+), 13 deletions(-) diff --git a/README.mkd b/README.mkd index 88af9b6..db4adbe 100644 --- a/README.mkd +++ b/README.mkd @@ -19,20 +19,28 @@ You can pull all the pieces of Shoreleave into your project by adding the follow (defproject ... :dependencies [[org.clojure/clojure "1.4.0"] - [shoreleave "0.2.2-SNAPSHOT"] - [shoreleave/shoreleave-remote-noir "0.2.2-SNAPSHOT"] + [shoreleave "0.2.2"] + [shoreleave/shoreleave-remote-noir "0.2.2"] ... ] ... ) ``` -Individual utilies can be pulled in with `[shoreleave/UTILITY "0.2.2-SNAPSHOT"]`. See the specific repo/artifact names below. +Individual utilies can be pulled in with `[shoreleave/UTILITY "0.2.2"]`. See the specific repo/artifact names below. Overview ---------- Shoreleave has support for the following: +### Common client-side interactions + + * An idiomatic interface to cookies + * An idiomatic interface to browser history (with extended support for HTML5 History API) + * BlobBuilders and on-demand asset building + * (Coming soon) An idiomatic interface to browser storage (Local Storage, Session Storage, and App Cache) + * Common auxiliary functions out-of-the-box to handle query strings, browser-repl, hash strings, and CLJS/JS interop + ### A remotes package Shoreleave's remotes package includes XHR, Pooled-XHR, JSONP, and HTTP-RPC capabilities. @@ -101,15 +109,6 @@ The simple pub/sub bus has little overhead but will only work in single document (In-progress) The cross document bus has a small amount of overhead, but allows you to publish and subscribe from/to functions that live in other web workers or windows (in-browser concurrency for "free"). - -### Common client-side interactions - - * An idiomatic interface to cookies - * An idiomatic interface to browser history (with extended support for HTML5 History API) - * BlobBuilders and on-demand asset building - * (Coming soon) An idiomatic interface to browser storage (Local Storage, Session Storage, and App Cache) - * Common auxiliary functions out-of-the-box to handle query strings, browser-repl, hash strings, and CLJS/JS interop - ### Common external API support Shoreleave has JSONP-wrapped support for external APIs including: @@ -123,6 +122,7 @@ Shoreleave has JSONP-wrapped support for external APIs including: * A `Function` object that supports metadata * The ability to create embedded web workers + Where's the code? ----------------- Shoreleave is a big project and has been split up into smaller pieces within the [Shoreleave organization](https://github.com/shoreleave): @@ -145,7 +145,17 @@ I have found it to pair particularly well with [Enfocus](https://github.com/ckir Examples and usage ------------------ -Please the github wiki for examples of each library feature +Please the github doc pages (ie: Marginalia docs) above for library specifics. + +There is a community-contributed [demo app](https://github.com/robert-stuttaford/demo-enfocus-pubsub-remote) thanks to the hard work of [Robert Stuttaford](https://github.com/robert-stuttaford) + + +Google Group and General Help +------------------------------ +There is a [Shoreleave CLJS]() Google Group. Please feel free to post all questions and general comments there. + +Additionally, you can ping `ohpauleez` in #clojure on Freenode. + License ------- From 5dea624d747f06f80de3497400431d4163053513 Mon Sep 17 00:00:00 2001 From: Paul deGrandis Date: Tue, 4 Sep 2012 14:47:24 -0700 Subject: [PATCH 2/5] README now includes updated bus information --- README.mkd | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.mkd b/README.mkd index db4adbe..f49afeb 100644 --- a/README.mkd +++ b/README.mkd @@ -104,11 +104,13 @@ It's often most beneficial to use DOM listeners as entry-points into the pub/sub Shoreleave's pub/sub system is built upon two protocols: "brokers" and "publishables" Out of the box, Shoreleave allows you to publish funtions, atoms, web workers, and anything that implements (str ...)/.toString, as topics. -The simple pub/sub bus has little overhead but will only work in single document cases. +The `simple` pub/sub bus has very little overhead, but operates synchronously. You can trade-off some performance for an async bus, the `event` pubsub bus. (In-progress) The cross document bus has a small amount of overhead, but allows you to publish and subscribe from/to functions that live in other web workers or windows (in-browser concurrency for "free"). +In most cases, the simple bus is the best choice. + ### Common external API support Shoreleave has JSONP-wrapped support for external APIs including: From a2b3e3b8a0033a071edeae76e571d1d02257df14 Mon Sep 17 00:00:00 2001 From: Paul deGrandis Date: Tue, 4 Sep 2012 15:15:34 -0700 Subject: [PATCH 3/5] Marg doc updates --- README.mkd | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.mkd b/README.mkd index f49afeb..54dfaa4 100644 --- a/README.mkd +++ b/README.mkd @@ -133,8 +133,8 @@ Shoreleave is a big project and has been split up into smaller pieces within the * [shoreleave-browser](https://github.com/shoreleave/shoreleave-browser) - [Marg docs](http://shoreleave.github.com/shoreleave-browser/) * [shoreleave-pubsub](https://github.com/shoreleave/shoreleave-pubsub) - [Marg docs](http://shoreleave.github.com/shoreleave-pubsub/) * [shoreleave-remote](https://github.com/shoreleave/shoreleave-remote) - [Marg docs](http://shoreleave.github.com/shoreleave-remote/) - * [shoreleave-remote-noir](https://github.com/shoreleave/shoreleave-remote-noir) - Marg docs coming - * [shoreleave-services](https://github.com/shoreleave/shoreleave-services) - Marg docs coming + * [shoreleave-remote-noir](https://github.com/shoreleave/shoreleave-remote-noir) - [Marg docs](http://shoreleave.github.com/shoreleave-remote-noir/) + * [shoreleave-services](https://github.com/shoreleave/shoreleave-services) - [Marg docs](http://shoreleave.github.com/shoreleave-services/) * [shoreleave-worker](https://github.com/shoreleave/shoreleave-worker) - [Marg docs](http://shoreleave.github.com/shoreleave-worker/) From 04c2f5a10be0db111b5354df837b331d59216ca5 Mon Sep 17 00:00:00 2001 From: Paul deGrandis Date: Tue, 4 Sep 2012 15:16:25 -0700 Subject: [PATCH 4/5] Update README.mkd --- README.mkd | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.mkd b/README.mkd index 54dfaa4..995aa70 100644 --- a/README.mkd +++ b/README.mkd @@ -133,8 +133,8 @@ Shoreleave is a big project and has been split up into smaller pieces within the * [shoreleave-browser](https://github.com/shoreleave/shoreleave-browser) - [Marg docs](http://shoreleave.github.com/shoreleave-browser/) * [shoreleave-pubsub](https://github.com/shoreleave/shoreleave-pubsub) - [Marg docs](http://shoreleave.github.com/shoreleave-pubsub/) * [shoreleave-remote](https://github.com/shoreleave/shoreleave-remote) - [Marg docs](http://shoreleave.github.com/shoreleave-remote/) - * [shoreleave-remote-noir](https://github.com/shoreleave/shoreleave-remote-noir) - [Marg docs](http://shoreleave.github.com/shoreleave-remote-noir/) - * [shoreleave-services](https://github.com/shoreleave/shoreleave-services) - [Marg docs](http://shoreleave.github.com/shoreleave-services/) + * [shoreleave-remote-noir](https://github.com/shoreleave/shoreleave-remote-noir) - Temp [Marg docs](http://shoreleave.github.com/shoreleave-remote-noir/) + * [shoreleave-services](https://github.com/shoreleave/shoreleave-services) - Temp [Marg docs](http://shoreleave.github.com/shoreleave-services/) * [shoreleave-worker](https://github.com/shoreleave/shoreleave-worker) - [Marg docs](http://shoreleave.github.com/shoreleave-worker/) From f51615f5a4870d968a6ede77361d9323a1056c7a Mon Sep 17 00:00:00 2001 From: Paul deGrandis Date: Tue, 4 Sep 2012 15:20:28 -0700 Subject: [PATCH 5/5] Update README.mkd --- README.mkd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.mkd b/README.mkd index 995aa70..95e1c2e 100644 --- a/README.mkd +++ b/README.mkd @@ -154,7 +154,7 @@ There is a community-contributed [demo app](https://github.com/robert-stuttaford Google Group and General Help ------------------------------ -There is a [Shoreleave CLJS]() Google Group. Please feel free to post all questions and general comments there. +There is a [Shoreleave CLJS](https://groups.google.com/forum/#!forum/shoreleave-cljs) Google Group. Please feel free to post all questions and general comments there. Additionally, you can ping `ohpauleez` in #clojure on Freenode.