RedSnow

API Blueprint Parser for Ruby

Ruby binding for the Snow Crash library, also a thermonuclear weapon.

API Blueprint is Web API documentation language. You can find API Blueprint documentation on the API Blueprint site.

Install

The best way to install RedSnow is by using its GEM package.

gem install redsnow

Documentation

• Documentation at rubydoc

Getting started

require 'redsnow'

result = RedSnow::parse('# My API')
puts result.ast.name

Hacking Redsnow

You are welcome to contribute. Use following steps to build & test Redsnow.

Build

1. If needed, install bundler:

   $ gem install bundler
   

2. Clone the repo + fetch the submodules:

   $ git clone git://github.com/apiaryio/redsnow.git
   $ cd redsnow
   $ git submodule update --init --recursive
   

3. Build:

   $ rake
   

Test

Inside the redsnow repository run:

$ bundle install
$ rake test

Contribute

Fork & Pull Request.

License

MIT License. See the LICENSE file.