From 78270bd44ccfb1bcd1fd03f04f597de34525c0c5 Mon Sep 17 00:00:00 2001 From: Cameron Yick Date: Mon, 7 Mar 2022 19:20:34 -0500 Subject: [PATCH] docs: Add contribution steps to README (fixes #43) --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index b634a87..f64a0ad 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,23 @@ If you are publishing data using the `datasette publish` command, you can include this plugin like so: datasette publish now mydatabase.db --install=datasette-vega + +## Development + +To contribute to this tool, first checkout the code. + +```bash +git clone git@github.com:simonw/datasette-vega.git +``` + +Then, install dependencies + +```bash +npm install +``` + +Then, you will be able to run a hot-reloading development server. + +```bash +npm run start +```