From 8a48701311cf1bf03006000b942ccc3baed031ec Mon Sep 17 00:00:00 2001
From: Ian Ward <ian@excess.org>
Date: Tue, 24 Dec 2024 10:05:43 -0500
Subject: [PATCH] add bin scripts to README

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 8026304b..7b16e8eb 100644
--- a/README.md
+++ b/README.md
@@ -98,6 +98,16 @@ Use this mode if you are making code changes to CKAN and either creating new ext
 
 To develop local extensions use the `docker-compose.dev.yml` file with help from the scripts under `bin`:
 
+dev script | description
+--- | ---
+`bin/ckan …` | exec `ckan` cli within the ckan-dev container
+`bin/compose …` | dev docker compose commands
+`bin/generate_extension` | generate extension in `src` directory
+`bin/install_src` | install all extensions from `src` directory (ckan-dev does not need to be running)
+`bin/reload` | reload ckan within the ckan-dev container without restarting
+`bin/restart` | shut down and restart the whole ckan-dev container (loads new values from .env)
+`bin/shell` | exec bash prompt within the ckan-dev container
+
 To build the images:
 
 	bin/compose build