Skip to content
This repository was archived by the owner on Aug 15, 2018. It is now read-only.

Minor improvements to README.md (without any significat content change) #1

Merged
merged 1 commit into from
Nov 7, 2013
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Importr

Rails Engine which extends active-admin to import excel files, based on top of [Active-Importer](https://github.com/continuum/active_importer) dsl import.
Extends active-admin to import excel files. Based on [Active-Importer](https://github.com/continuum/active_importer) dsl import.

[![Build Status](https://secure.travis-ci.org/continuum/importr.png)](http://travis-ci.org/continuum/importr) [![Coverage Status](https://coveralls.io/repos/continuum/importr/badge.png)](https://coveralls.io/r/continuum/importr)
=======
Expand All @@ -11,21 +11,21 @@ Add this line to your application's Gemfile:

gem 'importr'

And then execute:
Then execute:

$ bundle

Or install it yourself as:
Or just install it as gem if you don't use bundler:

$ gem install importr

## Usage

Install migrations
Install migrations:

$ rake importr:install:migrations

Add an your importers in app/importers
Add your importers in app/importers. Here is a importer example:

class PricingImporter < Importr::Importer
imports Pricing
Expand All @@ -47,7 +47,9 @@ Go to active-importer documentation for more information about importers

### WebSocket integration, Faye example

If you need to emit the progress of importation in realtime, like errors validations, you can configure the Importer in an initializer for websocket notification:
If you need to notify the progress of a import in real time (and
errors or validation issues), you can configure websocket notification
in an initializer:


Importr::Config.setup do |config|
Expand All @@ -57,11 +59,11 @@ If you need to emit the progress of importation in realtime, like errors validat
config.websocket_client_script = "http://localhost:8000/faye/client.js"
end

Importr will manage the event publication for errors send notifications with FayeWrapper.publish
Importr will manage the event publication for errors and send notifications with FayeWrapper.publish.

### Faye Wrapper example

in config/initializers/faye.rb write something like
In config/initializers/faye.rb write something like

WS_CLIENT = Faye::Client.new('http://localhost:8000/faye')

Expand All @@ -80,9 +82,8 @@ in config/initializers/faye.rb write something like

Finnaly you must to run a Faye server

## Dependences
## Dependencies

[SideKiq](https://github.com/mperham/sidekiq)

[CarrierWave](https://github.com/carrierwaveuploader/carrierwave)