Adding short pkg description for the benefit of pkg.go.dev.

canonical · Oct 10, 2024 · 9ed7a4c · 9ed7a4c
1 parent b817597
commit 9ed7a4c
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/cmd/ubuntu-image/main.go b/cmd/ubuntu-image/main.go
@@ -1,3 +1,14 @@
+// Package ubuntu-image provides a tool used for generating bootable images.
+// You can use it to build two types of Ubuntu images:
+//
+// * Snap-based Ubuntu Core images from model assertions
+// * Classical preinstalled Ubuntu images using image definitions
+//
+// ubuntu-image is intended to be used as Snap package available from
+// https://snapcraft.io/ubuntu-image
+//
+// See the project README for more details:
+// https://github.com/canonical/ubuntu-image
 package main
 
 import (