Sha256: c2e983aa8d4e434f6ea2a9fa0e38f563bc06c889f0376bc7c037d9794d60ed17

Contents?: true

Size: 1.38 KB

Versions: 1

Compression:

Stored size: 1.38 KB

Contents

# Epubber
This gem allows you to easily build EPUB files programatically.

## Installation
Add this line to your application's Gemfile:

```ruby
gem 'epubber'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install epubber

## Usage
Epubber's DSL is rather simple:

```ruby
path = Epubber.generate do |b|
  b.title 'My First EPUB book'
  b.author 'Ramirez, Federico'
  b.description 'This is an example EPUB'
  b.url 'http://my-url.com'

  b.cover do |c|
    c.file File.new('my-image.jpg')
  end

  b.introduction do |i|
    i.content '<p>This is an introduction.</p>'
  end

  b.chapter do |c|
    c.title 'Chapter 1'
    c.content '<p>This is some content!</p>'
  end

  b.chapter do |c|
    c.title 'Chapter 2'
    c.content '<p>Some more content this is.</p>'
  end
end

# Now the `path` variable contains the full path of the generated EPUB file.
# Defaults to `#{title}.epub`
``` 

You can configure the generator 

```ruby
path = Epubber.generate filename: 'some-file.epub', workspace: '/tmp' do |b|
  # Ebook code here...
end
``` 

## Contributing

1. Fork it ( https://github.com/gosukiwi/epubber/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Running tests
Running tests is as easy as running `rake`.

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
epubber-0.2.0 README.md