From a6f83092fa786023526b7fc86641b91d634b4774 Mon Sep 17 00:00:00 2001 From: ikappaki Date: Mon, 7 Oct 2024 20:03:00 +0100 Subject: [PATCH] update readme, reset version number to 0.1.0b1 --- README.md | 7 +++++-- pyproject.toml | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1e0ada6..8472388 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # A Basilisp async nREPL server for cooperative multitasking ## Overview -`basilisp-nrepl-async` is an nREPL server implementation for Basilisp that allows client requests to be evaluated asynchronously by the main program at a chosen time and place. This enables cooperative multitasking on a single thread between the program and the nREPL server. +`basilisp-nrepl-async` is an nREPL server implementation for [Basilisp](https://basilisp.readthedocs.io/en/latest/) that allows client requests to be evaluated asynchronously by the main program at a chosen time and place. This enables cooperative multitasking on a single thread between the program and the nREPL server on the Python VM. ## Installation @@ -15,7 +15,7 @@ pip install basilisp-nrepl-async ## Usage -Start the nREPL server in async mode and periodically call its `work-fn` within the program's main loop +To start the nREPL server on a random port bound to the local interface, call the the `basilisp-nrepl-async.nrepl-server/server-start!` function with the `async?` option set to `true`, and periodically invoke the returned `work-fn` within your program's main loop. ```clojure (require '[basilisp-nrepl-async.nrepl-server :as nr]) @@ -40,6 +40,9 @@ Start the nREPL server in async mode and periodically call its `work-fn` within (recur)))) ``` +The server will create an `.nrepl-port` file in the current working directory with the port number, which nREPL-enabled Clojure editors can use to connect. + +You can also pass additional options to the `server-start!` function, such as `:address` and `:port`, to explicitly set the server's listening interface and port, respectively. See the function documentation for more details. ## Development and Testing diff --git a/pyproject.toml b/pyproject.toml index 1ef86af..c07d2e5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "basilisp-nrepl-async" -version = "0.1.1a0" +version = "0.1.0b1" description = "" authors = ["ikappaki "] readme = "README.md"