diff --git a/README.md b/README.md index 3f5ec2b..e1ba3cc 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,22 @@ It includes support for running Framework data loaders with the following langua - Node 20 - Python 3.11 -- R 4.3 -- duckdb 0.10.1 -- Rust 1.77 +- R 4.4 +- duckdb 1.0 +- Rust 1.81 +- Perl 5.36 ## Usage -This will be published on a public repository soon. In the mean time, please use the local development instructions below. +The image built from this repository is published on the GitHub container registry. + +``` +docker run -it ghcr.io/observablehq/framework-runtime +``` ## Local development -From this repository, run +To build and test the images locally, from this repository, run ``` yarn install @@ -32,3 +37,9 @@ docker run -it observablehq/framework-runtime:latest bash ``` This will launch a shell in the runtime environment. From here you should be able to clone repositories, use `npm init @observablehq`, and otherwise interact with Framework projects. Not that after exiting the shell any files you worked with will be lost. Consider using [Docker Volumes](https://docs.docker.com/storage/volumes/) if you want a persistent environment. + +There are automated tests that ensure that various commands and tools are available, and of the expected versions. To run those, use + +``` +yarn test +```