README.md in imperavi-rails-0.0.3.beta vs README.md in imperavi-rails-0.0.4.beta
- old
+ new
@@ -7,11 +7,11 @@
## Installation
Put this line into your Gemfile:
```ruby
-gem 'imperavi-rails'
+gem 'imperavi-rails', '0.0.4.beta'
```
Then mount the engine in routes.rb:
```ruby
@@ -22,48 +22,48 @@
## Usage
Add this helpers into the your view that contains a form:
-```ruby
- <%= include_imperavi_stylesheet %>
- <%= include_imperavi_javascript %>
- <%= imperavi :page_article %>
+```erb
+<%= 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";
+@import "imperavi-rails/imperavi/imperavi-base";
- body {
- width: 700px;
- margin: 0 auto;
+body {
+ width: 700px;
+ margin: 0 auto;
- article {
- overflow: hidden;
- @include imperavi-base;
+ article {
+ overflow: hidden;
+ @include imperavi-base;
- p, div {
- border: 0;
- }
+ p, div {
+ border: 0;
+ }
- p {
- padding: 0;
- margin: 0 0 1.5em 0;
- }
- }
+ p {
+ padding: 0;
+ margin: 0 0 1.5em 0;
+ }
+ }
- form {
- textarea {
- width: 700px;
- height: 600px;
- }
- }
+ form {
+ textarea {
+ width: 700px;
+ height: 600px;
}
+ }
+}
```
## Deal with images
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.
@@ -80,5 +80,9 @@
* Fork the project on Github
* Create a topic branch for your changes
* Ensure that the changes in your branch are as atomic as possible
* Create a pull request on Github
+
+# TODO
+
+* [Read TODO here](https://github.com/tanraya/imperavi-rails/blob/master/TODO.md)