thumbit 0.0.2 → 0.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. data/README.rdoc +38 -0
  2. data/lib/thumbit/version.rb +1 -1
  3. metadata +4 -4
  4. data/README +0 -37
@@ -0,0 +1,38 @@
1
+ =Thumbit
2
+ A simple like plugin for rails.
3
+
4
+ == Requirements
5
+ I have only tested this with :
6
+ Rails version : 3.0.1
7
+ Rubygems version : 1.3.7
8
+ Bundler version : 1.0.3
9
+
10
+ == Installation
11
+ <b>As a plugin</b>
12
+ <tt>rails plugin install git://github.com/madhums/thumbit.git</tt>
13
+
14
+ <b>As a gem</b>
15
+ Include the below in your 'Gemfile' and run <tt>bundle install</tt>
16
+ <tt>gem 'thumbit', '0.0.1'</tt>
17
+
18
+ == Example
19
+ You have a model 'Post',
20
+
21
+ <tt>class Post < ActiveRecord::Base
22
+ acts_as_likeable
23
+ end</tt>
24
+
25
+ <tt>@post.like_it current_user</tt> # current_user being the user object
26
+ <tt>Post.find_likes_by user_obj</tt> # user_obj being the user object
27
+ <tt>Post.find_likes_for @post</tt> # @post being the instance of the class Post
28
+
29
+ <em>Please feel free to fork and make your own changes.</em>
30
+
31
+ == TODO
32
+ * Architect properly
33
+ * Create proper documentation
34
+ * Create proper tests
35
+
36
+ <b>Credits</b> : Highly inspired by acts_as_commentable and acts_as_rateable. This my first plugin/gem !
37
+
38
+ Copyright (c) 2010 [Madhusudhan], released under the MIT license
@@ -1,3 +1,3 @@
1
1
  module Thumbit
2
- VERSION = "0.0.2"
2
+ VERSION = "0.0.3"
3
3
  end
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: thumbit
3
3
  version: !ruby/object:Gem::Version
4
- hash: 27
4
+ hash: 25
5
5
  prerelease: false
6
6
  segments:
7
7
  - 0
8
8
  - 0
9
- - 2
10
- version: 0.0.2
9
+ - 3
10
+ version: 0.0.3
11
11
  platform: ruby
12
12
  authors:
13
13
  - Madhusudhan Srinivasa
@@ -30,7 +30,7 @@ extra_rdoc_files: []
30
30
 
31
31
  files:
32
32
  - MIT-LICENSE
33
- - README
33
+ - README.rdoc
34
34
  - Rakefile
35
35
  - init.rb
36
36
  - install.rb
data/README DELETED
@@ -1,37 +0,0 @@
1
- Thumbit
2
- ==============
3
-
4
- A simple like plugin for rails.
5
-
6
- I have only tested this with :
7
- Rails version : 3.0.1
8
- Rubygems version : 1.3.7
9
- Bundler version : 1.0.3
10
-
11
- To install it as a plugin
12
- rails plugin install git://github.com/madhums/thumbit.git
13
-
14
- To install it as a gem, include the below in your 'Gemfile' and run "bundle install"
15
- gem 'thumbit', '0.0.1'
16
-
17
- Example
18
- =======
19
-
20
- You have a model 'Post',
21
-
22
- class Post < ActiveRecord::Base
23
- acts_as_likeable
24
- end
25
-
26
- @post.like_it current_user # current_user being the user object
27
- Post.find_likes_by user_obj # user_obj being the user object
28
- Post.find_likes_for @post # @post being the instance of the class Post
29
-
30
- Please feel free to fork and make your own changes.
31
-
32
- TODO : Create proper documentation
33
- Create proper tests
34
-
35
- Credits : Highly inspired by acts_as_commentable and acts_as_rateable. This my first plugin/gem !
36
-
37
- Copyright (c) 2010 [Madhusudhan], released under the MIT license