From be16f5e31053840a5b6f56ad106153f9bc57702f Mon Sep 17 00:00:00 2001 From: Jay Date: Fri, 21 Dec 2018 18:42:03 -0500 Subject: [PATCH 1/4] Added REPL, REBL, Client illustration to README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 72f98c4..e65ad72 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,16 @@ REBL is a graphical, interactive tool for browsing Clojure data. REBL is extract REBL runs in your application JVM process, and can be used at dev-time without adding any runtime deps. The UI is written in JavaFX. +

+ +- Start your REPL or run REBL as your REPL with `clj -m congitect.rebl` +- Send Clojure forms to your REPL manually, from your client or editor, or the REBL evaluation window +- Inspect the evaluation results and navigate through nested data structures within the REBL UI. + ## Release Status REBL is early access. Your feedback can help make it better. Please report any [issues](https://github.com/cognitect-labs/REBL-distro/issues) that you encounter. From e8cb34856e7636ed5b75f96672e77b8ebe5925c6 Mon Sep 17 00:00:00 2001 From: Jay Date: Fri, 21 Dec 2018 18:59:22 -0500 Subject: [PATCH 2/4] Replaced proposed illustration with better quality export --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e65ad72..8e64ddc 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ REBL runs in your application JVM process, and can be used at dev-time without a

From c58a52c56439b1ec536bdc4ac30eaef1c21c164a Mon Sep 17 00:00:00 2001 From: Jay Date: Fri, 21 Dec 2018 21:55:52 -0500 Subject: [PATCH 3/4] Refined REBL-to-editor copy supporting illustration --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8e64ddc..35fe417 100644 --- a/README.md +++ b/README.md @@ -29,9 +29,14 @@ REBL runs in your application JVM process, and can be used at dev-time without a

-- Start your REPL or run REBL as your REPL with `clj -m congitect.rebl` -- Send Clojure forms to your REPL manually, from your client or editor, or the REBL evaluation window -- Inspect the evaluation results and navigate through nested data structures within the REBL UI. +## How do I connect my editor to REBL? + +- REBL provides a REPL you can use with REBL via `clj -A rebl -m cognitect.rebl` +- You can connect your editor to REBL by running the REBL command-line REPL with JVM socket server arguments. +- Your editor can also communicate with your REBL REPL by running it as an inferior process inside your editor. + +## What about other network REPLs? +- For nREPL or similar you will need to use middleware to communicate with the REBL UI. However, this approach has drawbacks due to the format of data sent across the wire. It is recommended to use the REBL command-line REPL for best results. ## Release Status From f0eb07c437a3c502b5ce1716742698d759fadefd Mon Sep 17 00:00:00 2001 From: Jay Date: Fri, 21 Dec 2018 21:58:39 -0500 Subject: [PATCH 4/4] Updated illustration in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 35fe417..4e618cb 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ REBL runs in your application JVM process, and can be used at dev-time without a