summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThomas Graf <tgraf@suug.ch>2013-07-09 20:02:42 +0200
committerThomas Graf <tgraf@suug.ch>2013-07-09 20:02:42 +0200
commita4d7a0ef42da73233bb646cfbc38f5714988f121 (patch)
treefa4c2c658c80500ee399ceeaf89cb4c35134cce7
parent369af04a27aded94448b596fa14c8a4b84bea5ad (diff)
Updated README file
-rw-r--r--README.adoc25
-rw-r--r--README.md9
2 files changed, 25 insertions, 9 deletions
diff --git a/README.adoc b/README.adoc
new file mode 100644
index 0000000..e3de49d
--- /dev/null
+++ b/README.adoc
@@ -0,0 +1,25 @@
+= bmon =
+:license: https://github.com/tgraf/bmon/blob/master/LICENSE
+
+bmon is a monitoring and debugging tool to capture networking related
+statistics and prepare them visually in a human friendly way. It
+features various output methods including an interactive curses user
+interface and a programmable text output for scripting.
+
+== Usage
+
+To run bmon in the default curses mode:
+
+ bmon
+
+There are many other options available and full help is
+provided via:
+
+ bmon --help
+
+== Copyright
+
+ Copyright (c) 2001-2013 Thomas Graf <tgraf@suug.ch>
+ Copyright (c) 2013 Red Hat, Inc.
+
+Please see the {license}[LICENSE] file for details.
diff --git a/README.md b/README.md
deleted file mode 100644
index 50255a0..0000000
--- a/README.md
+++ /dev/null
@@ -1,9 +0,0 @@
-bmon
-====
-
-bandwidth monitor and rate estimator
-
-bmon is a monitoring and debugging tool to capture networking related
-statistics and prepare them visually in a human friendly way. It
-features various output methods including an interactive curses user
-interface and a programmable text output for scripting.