README.md in imperavi-rails-0.0.2.beta vs README.md in imperavi-rails-0.0.3.beta

- old
+ new

@@ -6,30 +6,37 @@ ## Installation Put this line into your Gemfile: - gem 'imperavi-rails' +```ruby +gem 'imperavi-rails' +``` Then mount the engine in routes.rb: - mount ImperaviRails::Engine => "/imperavi" +```ruby +mount ImperaviRails::Engine => "/imperavi" +``` And you're done! ## Usage Add this helpers into the your view that contains a form: +```ruby <%= include_imperavi_stylesheet %> <%= include_imperavi_javascript %> <%= imperavi :page_article %> +``` In this example `page_article` is an id of textarea field. You can pass additional options to `imperavi` helper as second argument. See the full list of options here: https://github.com/tanraya/imperavi-rails/blob/master/app/helpers/imperavi_rails/imperavi_helper.rb#L35 You may want the text on your page to be styled the same way as it looks in the editor. To do this, add the following styles into your `application.css.scss` (provided that the text on the page is enclosed with `article` tag): +```scss @import "imperavi-rails/imperavi/imperavi-base"; body { width: 700px; margin: 0 auto; @@ -53,13 +60,18 @@ width: 700px; height: 600px; } } } +``` -## Deal with images: uploading, images list +## Deal with images -For details look at the Dummy app sources: https://github.com/tanraya/imperavi-rails/tree/master/spec/dummy +Uploading images is not part of the imperavi-rails. You have to implement this functionality in your application yourself. It's easy. Read the docs below. + +* [How to upload images with imperavi-rails](https://github.com/tanraya/imperavi-rails/wiki/How-to-upload-images-with-imperavi-rails) + +Also you can see Dummy app that has working images uploading: https://github.com/tanraya/imperavi-rails/tree/master/spec/dummy # Contribute I would appreciate any participation in the project. Any additions, fixes and ideas are welcome!