From 0a12dda95fa19f9e1fcf9a9a30f7b4a1e581e6f4 Mon Sep 17 00:00:00 2001 From: Justin Mayfield Date: Fri, 18 Sep 2015 13:49:47 -0600 Subject: [PATCH] Update README.md --- README.md | 35 +++++++++++++---------------------- 1 file changed, 13 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 414a11c..7340bfe 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,17 @@ -shellish - Command-line/shell mashup framework. +shellish =========== +**_Command-line/shell mashup framework_** + +[![PyPI](https://img.shields.io/pypi/status/shellish.svg)](https://pypi.python.org/pypi/shellish) +[![PyPI](https://img.shields.io/pypi/l/shellish.svg)](https://pypi.python.org/pypi/shellish) +[![Change Log](https://img.shields.io/badge/change-log-blue.svg)](https://github.com/mayfield/shellish/blob/master/CHANGELOG.md) +[![Build Status](https://semaphoreci.com/api/v1/projects/d925ee35-bede-4cc1-bbb8-17a738b84cfa/533600/shields_badge.svg)](https://semaphoreci.com/mayfield/shellish) +[![PyPI](https://img.shields.io/pypi/dm/shellish.svg)](https://pypi.python.org/pypi/shellish) + +-------- + + This module combines the Python standard library modules argparse and cmd to provide a unified way to make cli programs that can also be interactive (when invoked in "shell" mode). @@ -9,17 +20,11 @@ The main benefit to using this package is streamlined command hierarchy when you want to have rich set of subcommands along with a pretty powerful tab completion layer that parses argparse arguments automagically. -Status --------- - -[![Change Log](https://img.shields.io/badge/change-log-blue.svg)](https://github.com/mayfield/shellish/blob/master/CHANGELOG.md) -[![Build Status](https://semaphoreci.com/api/v1/projects/d925ee35-bede-4cc1-bbb8-17a738b84cfa/533600/shields_badge.svg)](https://semaphoreci.com/mayfield/shellish) - Requirements -------- -* None more black! +Posix-like platform Installation @@ -50,20 +55,6 @@ Compatibility * Python 3.4+ -TODO --------- - -* Documentation -* Documentation -* Documentation - - -Getting Started --------- - -TBD - - Examples --------