diff --git a/README.md b/README.md index eaa73fc3..c678a3b6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,20 @@ -# boot-c extension +# Bootable Container Extension -Run in development mode: +This extension provides support for bootable containers (bootc and image builder) +to Podman Desktop. + +# Features + +- Adds a badge to all bootable containers (currently looks for the + 'ostree.bootable' label, but this will change). +- Adds a custom icon to all bootable containers. +- Adds a menu item to bootable containers to launch image builder to create + a disk image. + +# How to test/develop + +To run in development mode, clone Podman Desktop and this repo. Follow the +Podman Desktop instructions on launching in dev mode, but add the path to +this extension: `yarn watch --extension-folder ~/git/projectatomic/bootc-extension` diff --git a/package.json b/package.json index 03966376..c2b58f93 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "bootc-extension", - "displayName": "bootc", - "description": "Integration with bootc", + "displayName": "Bootable Container", + "description": "Support for bootable OS containers (bootc) and generating disk images", "version": "0.1.0-next", "icon": "icon.png", "publisher": "redhat",