Sha256: ce1c153b8528bbc1b3eea5b43f75c50cb8aa8aa560176817390e55b282519b34
Contents?: true
Size: 1.7 KB
Versions: 6
Compression:
Stored size: 1.7 KB
Contents
 # RedSnow [](https://travis-ci.org/apiaryio/redsnow) ### API Blueprint Parser for Ruby Ruby binding for the [Snow Crash](https://github.com/apiaryio/snowcrash) library, also a thermonuclear weapon. API Blueprint is Web API documentation language. You can find API Blueprint documentation on the [API Blueprint site](http://apiblueprint.org). ## Install The best way to install RedSnow is by using its [GEM package](https://rubygems.org/gems/redsnow). gem install redsnow ## Documentation - [Documentation at rubydoc](http://rubydoc.info/gems/redsnow/) ## Getting started ```ruby require 'redsnow' result = RedSnow::parse('# My API') puts result.ast.name ``` ## Parsing options Options can be number or hash. We support `:requireBlueprintName` and `:exportSourcemap` option. ```ruby require 'redsnow' result = RedSnow::parse('# My API', { :exportSourcemap => true }) puts result.ast.name puts result.sourcemap.name ``` ## Hacking Redsnow You are welcome to contribute. Use following steps to build & test Redsnow. ### Build 1. If needed, install bundler: ```sh $ gem install bundler ``` 2. Clone the repo + fetch the submodules: ```sh $ git clone git://github.com/apiaryio/redsnow.git $ cd redsnow $ git submodule update --init --recursive ``` 3. Build: ```sh $ rake ``` ### Test Inside the redsnow repository run: ```sh $ bundle install $ rake test ``` ### Contribute Fork & Pull Request. ## License MIT License. See the [LICENSE](https://github.com/apiaryio/protagonist/blob/master/LICENSE) file.
Version data entries
6 entries across 6 versions & 1 rubygems
Version | Path |
---|---|
redsnow-0.3.4 | README.md |
redsnow-0.3.3 | README.md |
redsnow-0.3.2 | README.md |
redsnow-0.3.1 | README.md |
redsnow-0.3.0 | README.md |
redsnow-0.2.1 | README.md |