Skip to content

Commit

Permalink
Updated README for Jekyll 2.0. [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
parkr committed May 13, 2014
1 parent 2f81284 commit 228c88f
Showing 1 changed file with 24 additions and 10 deletions.
34 changes: 24 additions & 10 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,18 +1,32 @@
jekyll-import
=============
# jekyll-import

[![Build Status](https://travis-ci.org/jekyll/jekyll-import.svg?branch=master)](https://travis-ci.org/jekyll/jekyll-import)

The new __Jekyll__ command for importing from various blogs to Jekyll format.

**Note: _migrators_ are now called _importers_ and are only available if one installs the `jekyll-import` _gem_.**

How `jekyll-import` works:
---
## How `jekyll-import` works:

### Jekyll v2.x

1. Install the _rubygem_ with `gem install jekyll-import`.
2. Run `jekyll import IMPORTER [options]`

### Jekyll v1.x

Launch IRB:

Install the _rubygem_ with `gem install jekyll-import`
* In your IRB/Ruby configurations, `require jekyll-import`
* For CLI uses, the newly installed CLI command is now a Jekyll plugin/sub-command invoked with `jekyll import`
```ruby
# 1. Require jekyll-import
irb> require 'jekyll-import'
# 2. Choose the importer you'd like to use.
irb> importer_class = "Behance" # an example, there are many others!
# 3. Run it!
irb> JekyllImport::Importers.const_get(importer_class).run(options_hash)
```

Read [Blog migrations](http://jekyllrb.com/docs/migrations/) for more detailed info.
## Documentation

[![Build
Status](https://travis-ci.org/jekyll/jekyll-import.png?branch=master)](https://travis-ci.org/jekyll/jekyll-import)
jekyll-import has its own documentation site, found at http://import.jekyllrb.com.
Dedicated [documentation for each migrator](http://import.jekyllrb.com/docs/home/) is available there.

0 comments on commit 228c88f

Please sign in to comment.