Sha256: c061e78e6c221b0615a05a77df44484ea95e8a4c75a72f7ead950c44960ec388

Contents?: true

Size: 1.66 KB

Versions: 1

Compression:

Stored size: 1.66 KB

Contents

# Pricecut [![Build Status][build_status_image]][build_status]

Pricecut takes your HTML and marks it down.

## Installation

Add this line to your application's Gemfile:

    gem 'pricecut'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install pricecut

## Usage

```ruby
require "pricecut"

html = <<-HTML
  <h1>Pricecut is Awesome!</h1>

  <p>
    Pricecut lets me take my <strong>HTML</strong> and 
    <em>mark it down</em>.
  </p>

  <p><img src="awesome.png" alt="Awesome" /></p>
HTML

Pricecut.parse(html)
# => # Pricecut is Awesome! #
#    Pricecut lets me take my **HTML** and _mark it down_.
#    ![Awesome](awesome.png)
```

## Supported Platforms

*  Ruby 1.8.7
*  Ruby 1.9.3
*  JRuby _(1.8 mode)_
*  JRuby _(1.9 mode)_
*  Rubinius _(1.8 mode)_
*  Rubinius _(1.9 mode)_

## TODO

*  Decouple `MarkdownVisitor` from `Pricecut::Elements`.
*  Document code.
*  Add support for Markdown code blocks.
*  Add indentation support.
*  Add word-wrap support. _(80 characters)_
*  Make `Pricecut::Elements` classes configurable.
   _(e.g. Use your own custom class for `<hr />` if you want.)_

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

## Copyright
Copyright (c) 2012 [Adam Tanner][email]. See [License][license] for details.

[email]: mailto:adam@adamtanner.org
[license]: https://github.com/adamtanner/pricecut/blob/master/LICENSE.md
[build_status]: http://travis-ci.org/adamtanner/pricecut
[build_status_image]: https://secure.travis-ci.org/adamtanner/pricecut.png

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
pricecut-0.0.3 README.md