Skip to content

Commit

Permalink
update readme, reset version number to 0.1.0b1
Browse files Browse the repository at this point in the history
  • Loading branch information
ikappaki committed Oct 7, 2024
1 parent 71304ee commit a6f8309
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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])
Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "basilisp-nrepl-async"
version = "0.1.1a0"
version = "0.1.0b1"
description = ""
authors = ["ikappaki <ikappaki@users.noreply.github.com>"]
readme = "README.md"
Expand Down

0 comments on commit a6f8309

Please sign in to comment.