Permalink
Browse files

README & dependency gems

  • Loading branch information...
Sandip Ransing
Sandip Ransing committed Feb 12, 2011
1 parent 795ec7a commit 9bcdc1b09ed2916bbaba65d9a7ca0992f4107906
Showing with 23 additions and 20 deletions.
  1. +20 −20 README.md
  2. +3 −0 rails_tinymce.gemspec
View
@@ -2,63 +2,63 @@
TinyMCE is a javascript rich text editor. It is easy to integrate with blogs, cms, messages and mailers.
-Plugin uses jrails(jquery) and paperclip plugin for upload support.
+Plugin uses jrails(jQuery) and Paperclip plugin for image & media upload support
Features
--------------
-
-- Provides rich text editor
+- Provides Rich Text Editor
- Customisable TinyMCE plugins
- Easy to integrate
- Supports Image upload & insert
- Supports Media upload & Youtube embed
- TODO: Document upload plugin
-1. Install rails_tiny_mce plugin using
+1. Installation
---------------------
rails plugin install git://github.com/sandipransing/rails_tiny_mce.git
-
+
+2. Migrations
+---------------------
rails g tiny_migration
rake db:migrate
2. Install jrails(jquery) plugin using
-----------------
+---------------------
rails plugin install git://github.com/aaronchi/jrails.git
3. Install dependent plugins(if you did not already)
----------------------
+---------------------
rake rails_tiny_mce:plugins
-Above command will copy *paperclip, responds_to_parent, will_paginate* plugins to vendor/plugins directory.
+Above command will copy `paperclip`, `respond_to_parent`, `will_paginate` plugins to vendor/plugins directory.
- - **paperclip** git://github.com/thoughtbot/paperclip.git
- - **responds_to_parent** http://responds-to-parent.googlecode.com/svn/trunk
- - **will_paginate** git://github.com/mislav/will_paginate.git
+ - paperclip `git://github.com/thoughtbot/paperclip.git`
+ - respond_to_parent `git://github.com/itkin/respond_to_parent.git`
+ - will_paginate `git://github.com/mislav/will_paginate.git`
4. In your layout add following lines
------------------------
+---------------------
<%= javascript_include_tag :defaults %>
<%= javascript_include_tiny_mce_if_used %>
<%= tiny_mce if using_tiny_mce? %>
5. Inside controller class on top add following lines
--------------------------------------
+---------------------
uses_tiny_mce(:options => AppConfig.default_mce_options, :only => [:new, :edit])
-This AppConfig.default_mce_options is in *config/initializers/tiny_mce_plus_config.rb*, you could change the setting there
+This AppConfig.default_mce_options is in `config/initializers/tiny_mce_plus_config.rb`, you could change the setting there
6. In your view add class mceEditor to text_area
------------------------------
+---------------------
Then append the following to the text area you want to transform into a TinyMCE editor.
-
:class => :mceEditor
7. Install file lists
--------------------------
+---------------------
rake rails_tiny_mce:install
-will Install following files:
+will install following files:
app
|-- controller
@@ -83,8 +83,8 @@ will Install following files:
You may custom the config in tiny_mce_plus_config.rb.
## Attention Note:
-* Do not put *\<p> \</p>* around the textarea.
-* If you are using *old will_paginate plugin*, change the *url_for* to *url_option* in *remote_link_renderer.rb*
+* Do not put `\<p> \</p>` around the textarea.
+* If you are using `old will_paginate plugin`, change the *url_for* to *url_option* in *remote_link_renderer.rb*
## Example use:
View
@@ -13,6 +13,9 @@ Gem::Specification.new do |s|
s.description = %q{Supports Images and media upload, Easy to integrate with blogs, CMS, messages & mailers, newsletters}
s.rubyforge_project = "rails_tinymce"
+ s.add_dependency 'paperclip'
+ s.add_dependency 'jrails'
+ s.add_dependency 'will_paginate'
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")

0 comments on commit 9bcdc1b

Please sign in to comment.