From db9c1d85635e4a7a88bbd2b786ea187bf1c5c322 Mon Sep 17 00:00:00 2001 From: Kemal Akkoyun Date: Tue, 2 Aug 2022 17:56:38 +0200 Subject: [PATCH] Update readme Signed-off-by: Kemal Akkoyun --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 4b50ca9..03af074 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ +![Build](https://github.com/parca-dev/debug-info/actions/workflows/build.yml/badge.svg) +![Container](https://github.com/parca-dev/debug-info/actions/workflows/container.yml/badge.svg) +[![Apache 2 License](https://img.shields.io/badge/license-Apache%202-blue.svg)](LICENSE) + # debug-info A command line utility to handle tasks regarding debug information (extraction, upload and debugging) + +## Configuration + +Flags: + +[embedmd]:# (dist/help.txt) +```txt +Usage: debug-info + +Flags: + -h, --help Show context-sensitive help. + --log-level="info" Log level. + +Commands: + upload --store-address=STRING ... + Upload debug information files. + + extract ... + Extract debug information. + + buildid + Extract buildid. + +Run "debug-info --help" for more information on a command. +```