Merge ~merlijn-sebrechts/snappy-debug:main into snappy-debug:main

[Merlijn Sebrechts]

Update metadata of snap

This adds some info on how to use the tool, where to report bugs, and where to find the code.

Note: in order for the store to adopt this information, you need to enable the "update metadata on release" flag in the snap settings page: https://snapcraft.io/snappy-debug/settings

[Alex Murray (alexmurray)]

LGTM - thanks!

diff --git a/snapcraft.yaml b/snapcraft.yaml
index 5aa8833..ae736c8 100644
--- a/snapcraft.yaml
+++ b/snapcraft.yaml
@@ -1,7 +1,34 @@
 name: snappy-debug
 version: "0.36-snapd2.57.5"
-summary: Snappy debug tools
-description: Snappy debug tools
+summary: Tool for debugging snap confinement policy violations
+description: |
+  Snap developers can use this tool to help them debug and fix policy violations.
+
+  Each snap runs confined inside its own sandbox. The policy of each sandbox describes what the application is allowed to do. When an application tries to do something that is not allowed, the system logs a policy violation.
+
+  This snap
+
+  * watches syslog for such policy violations,
+  * shows them in a human readable format,
+  * and makes recommendations for how to solve them.
+
+  Run the following command to start watching policy violations.
+
+    sudo snappy-debug
+
+  If you have dropped messages, try the following command instead.
+
+    sudo journalctl --output=short --follow --all | sudo snappy-debug
+
+  Note: these commands only show policy violations that happen _after_ you run them. So first run one of these commands and then run the snap that you want to debug.
+
+  See `snappy-debug --help` for more information about this tool.
+website: https://launchpad.net/snappy-debug
+contact: https://bugs.launchpad.net/snappy-debug
+issues: https://bugs.launchpad.net/snappy-debug
+source-code: https://code.launchpad.net/snappy-debug
+license: GPL-3.0-or-later
+
 confinement: strict
 grade: stable
 base: core18