Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
toshimaru committed Jun 2, 2018
1 parent 6f971cd commit 6c4d8f9
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# Kramdown::Amp
# Kramdown Converter for Amp

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kramdown/amp`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

## Installation

Add this line to your application's Gemfile:
Expand All @@ -20,6 +18,14 @@ Or install it yourself as:

$ gem install kramdown-amp

## How it works

kramdown-amp works by monkey-patching `Kramdown::Converter::Html`.

## Supported amp tag

- img -> amp-img

## Usage

TODO: Write usage instructions here
Expand Down
4 changes: 2 additions & 2 deletions kramdown-amp.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
spec.authors = ["toshimaru"]
spec.email = ["me@toshimaru.net"]

spec.summary = %q{kramdown for AMP}
spec.description = %q{kramdown for AMP}
spec.summary = %q{Kramdown AMP Converter}
spec.description = %q{Kramdown AMP Converter}
spec.homepage = "https://github.com/toshimaru/kramdown-amp"
spec.license = "MIT"

Expand Down

0 comments on commit 6c4d8f9

Please sign in to comment.