Skip to content

Commit

Permalink
New README
Browse files Browse the repository at this point in the history
  • Loading branch information
pgaskin committed Mar 4, 2018
1 parent 44555ab commit dae405d
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
# kepubify
[![Build Status](https://travis-ci.org/geek1011/kepubify.svg?branch=master)](https://travis-ci.org/geek1011/kepubify) [![Go Report Card](https://goreportcard.com/badge/github.com/geek1011/kepubify)](https://goreportcard.com/report/github.com/geek1011/kepubify) [![GoDoc Reference](https://img.shields.io/badge/godoc-reference-blue.svg)](https://godoc.org/github.com/geek1011/kepubify/kepub)
<p align="center">
<h1 align="center">kepubify</h1>
<p align="center">
Kepubify converts epubs to kepubs.
</p>
<p align="center">
<a href="https://travis-ci.org/geek1011/kepubify"><img alt="Build Status" src="https://travis-ci.org/geek1011/kepubify.svg?branch=master" /></a>
<a href="https://goreportcard.com/report/github.com/geek1011/kepubify"><img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/geek1011/kepubify" /></a>
<a href="https://godoc.org/github.com/geek1011/kepubify/kepub"><img alt="GoDoc" src="https://img.shields.io/badge/godoc-reference-blue.svg" /></a>
</p>
<hr>
</p>

Convert your ePubs into kepubs, with an easy-to-use tool. Kepubify can also be embedded into your own apps with the import path `github.com/geek1011/kepubify/kepub`.

# [Docs](https://geek1011.github.io/kepubify)
Documentation is [here](https://geek1011.github.io/kepubify#docs).
## <a href="https://geek1011.github.io/kepubify">Documentation</a>
Documentation and examples can be found on the [kepubify website](https://geek1011.github.io/kepubify).

## Screenshots
| ![](docs/kepubify.gif) | ![](docs/kepubify-windows.gif) |
| ![](docs/kepubify_batch_macos.gif) | ![](docs/kepubify_macos.gif) |
| --- | --- |
| | |
| ![](docs/kepubify.gif) | ![](docs/kepubify-windows.gif) |

0 comments on commit dae405d

Please sign in to comment.