Sha256: d11f58c2b8592bf5c16d69d2455bfc69e50714744e5b69163ad6341d50949a0b

Contents?: true

Size: 1.36 KB

Versions: 3

Compression:

Stored size: 1.36 KB

Contents

apiaryio
=============

Apiary.io CLI


## Install

``` bash
gem install apiaryio
```


## Description

Apiaryio gem provides a way to test and display your API documentation on your local
machine, either using static files or using a standalone web server...

## Usage

    $ apiary help

    Usage: apiary command [options]
    Try 'apiary help' for more information.

    Currently available apiary commands are:

      preview                                     Show API documentation in default browser
      preview --browser [chrome|safari|firefox]   Show API documentation in specified browser
      preview --path [PATH]                       Specify path to blueprint file
      preview --api_host [HOST]                   Specify apiary host
      preview --server                            Start standalone web server on port 8080
      preview --server --port [PORT]              Start standalone web server on specified port
      okapi     help                              Show okapi testing tool help
      help                                        Show help

      version                                     Show version

## Copyright

Copyright 2012 (c) Apiary Ltd.

## Contributors

- Jakub Nešetřil
- James Charles Russell
- Lukáš Linhart
- Emili Parreño
- Peter Grilli [Tu1ly]

## License

Released under MIT license. See LICENSE file for further details.

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
apiaryio-0.0.5 README.md
apiaryio-0.0.4 README.md
apiaryio-0.0.3 README.md