Skip to content

Fix readme format #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix readme format #114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ unscripted [![pub package](https://img.shields.io/pub/v/unscripted.svg)](https:/

*Define command-line interfaces using ordinary dart methods and classes.*

##Installation
## Installation

```shell
pub global activate den
den install unscripted
```

##Usage
## Usage

The following [greet.dart][greet.dart] script outputs a configurable greeting:

Expand Down Expand Up @@ -53,7 +53,7 @@ Hi
Bob!!!
```

##Automatic --help
## Automatic --help

A `--help`/`-h` flag is automatically defined:

Expand Down Expand Up @@ -95,7 +95,7 @@ Examples:

```

##Sub-Commands
## Sub-Commands

Sub-commands are represented as `SubCommand`-annotated instance methods of
classes, as seen in the following [server.dart][server.dart]:
Expand Down Expand Up @@ -170,7 +170,7 @@ Options:
-h, --help Print this usage information.
```

##Parsers
## Parsers

Any value-taking argument (option, positional, rest) can have a "parser"
responsible for validating and transforming the string passed on the command
Expand All @@ -179,7 +179,7 @@ line. You can give an argument a parser simply by giving it a type (such as
`parser` named argument of the argument's metadata (`Option`, `Positional`, or
`Rest`).

##Plugins
## Plugins

Plugins allow you to mixin reusable chunks of cli-specific functionality
(options/flags/commands) on top of your base interface.
Expand All @@ -188,7 +188,7 @@ To add a plugin to your script, just add an instance of the associated plugin
class to the `plugins` named argument of your `@Command` annotation. The
following plugins are available:

###Tab Completion
### Tab Completion

Add bash/zsh [tab completion][tab completion] to your script:

Expand Down Expand Up @@ -253,12 +253,12 @@ a list of filenames in the current directory.

Tab completion is supported in [cygwin][cygwin], with one minor bug (#64).

###Other Plugins
### Other Plugins

There are several other plugins planned, and also the ability to write your own
is planned, see #62.

##Demo
## Demo

[den][] uses a large subset of the features above. Run `pub global activate den`
to install, and then `den -h` to get a feel for the UX provided by unscripted.
Expand Down