aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 38 insertions, 1 deletions
diff --git a/README.md b/README.md
index 87ce8f8..6627cb3 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,38 @@
-# rb-cmdline
+# Introduction
+`RbCmdline` is a simple Ruby library to built command line interface.
+
+# Motivation
+Existing Ruby library to build command line interface have complex API and
+abuse a of DSL. This library expose a simple API and do not use any DSL.
+
+# Documentation
+The [handbook](doc/handbook.md) contains information about various aspects of
+the library.
+
+You can also use the [yard](https://yardoc.org) documentation tool to read
+code documentation, for example:
+
+ yard doc
+
+# Contact
+If you find a bug or have any question, feel free to open a Github issue or to
+contact me [by email](mailto:bryan@frimin.fr).
+
+Please note that I do not currently review or accept any contribution.
+
+# License
+Released under the ISC license.
+
+Copyright (c) 2020 Bryan Frimin <bryan@frimin.fr>.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.