improve readmes

Author: gilesknap

.devcontainer/features/bash-config/README.md

@@ -1,14 +1,30 @@
-# Lightweight, Configurable BASH Eternal History
+# Lightweight, Configurable BASH Config with Eternal History
 
-## Defaults
+Intended as a lightweight alternative to common-utils.
 
-The default, opinionated configuration is defined in
-`$HOME/.config/bash-config/bash-config-rc` and includes the following:
+## Installation
+
+To use this feature in an individual devcontainer, add the following to your `.devcontainer/devcontainer.json`:
+
+```json
+    "features": {
+        "ghcr.io/diamondlightsource/devcontainer-features/bash-config:1": {}
+    },
+    "initializeCommand": "mkdir -p ${localEnv:HOME}/.config/bash-config",
+```
+
+The initializeCommand is required to create the directory for the bash-config folder in your home folder on the host, the very first time this is executed. Features do not have an InitializeCommand, so the devcontainer.json must do this.
+
+
+## features
+
+The default, opinionated configuration can be found in `$HOME/.config/bash-config/bash-config-rc` and includes the following:
 
 - Persistent history across all devcontainers that use this feature
 - The MS devcontainer bash prompt with git branch and status
 - history search with up/down arrows (.inputrc)
 - ctrl-left or right arrow for word navigation (.inputrc)
+- git autocomplete
 
 ## Customisation
 

README.md

@@ -1,28 +1,25 @@
 # Dev Container Features
 
-Some features for use in Python Copier Template development containers. Also intended to be generally useful in any developer container.
+Devcontainer features for use in Python Copier Template or any other devcontainer.
 
 ## bash-config
 
-Adds customizations to the bash shell that can be shared across all developer containers using the feature.
+Adds customizations to the the bash shell that can be shared across all developer containers using the feature.
 
-Default setup attempts to be a lightweight replacement for the common-utils feature zsh capabilities, namely:
-
-- useful prompt
-- eternal history (shared across all containers using the feature)
-- history search with up/down arrows (.inputrc)
-- ctrl-left or right arrow for word navigation (.inputrc)
+See details in the [bash-config README](src/bash-config/README.md).
 
 ## other
 
-Other features may be added here in future.
+Further features may be added here in future.
 
 ## Testing
 
-This repo has it's own devcontainer which can be used to do local testing of the features.
+This repo has it's own devcontainer which can be used to do local testing and development of the features.
 
 ## Publishing Features
 
-CI publishes the features defined here as follows:-
+CI verifies and publishes the feature(s) as follows:-
+
+- bash-config: ghcr.io/diamondlightsource/devcontainer-features/bash-config:1
 
-- bash-config: ghcr.io/gilesknap/devcontainer-features/bash-config:latest
+(the tag can be major, major.minor, major.minor.patch, or latest)