From bc9f1f5475eb0feaba3fb5eb9a97f49eb2247b6d Mon Sep 17 00:00:00 2001 From: Trevor Manz Date: Thu, 21 Nov 2024 10:29:48 -0500 Subject: [PATCH] Update readme with widget instructions --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e6c5f23..6717fdd 100644 --- a/README.md +++ b/README.md @@ -84,12 +84,14 @@ if you are looking for inspiration. This project uses [uv](https://github.com/astral-sh/uv) for development. -Run tests with: +### Tests ```sh uv run pytest ``` +### Auto-generate Schema Bindings + The schema bindings (`gosling/schema/`) and docs (`doc/user_guide/API.rst`) are automatically generated using the following. Please do not edit these files directly. @@ -99,6 +101,20 @@ files directly. uv run tools/generate_schema_wrapper.py ``` +### Widget + +This repo also includes an [anywidget](https://github.com/manzt/anywidget), +built with TypeScript using the Gosling.js library. Developing the widget +requires [Deno](https://deno.land/). Please ensure you have it installed. + +To modify the widget's behavior, edit `./frontend/widget.ts` and compile with: + +```sh +deno task build +``` + +Or use `deno task dev` to "watch" as you make changes and recompile automatically. + ## Release ```bash