README.md in kaltura_box-0.0.1 vs README.md in kaltura_box-0.0.2
- old
+ new
@@ -18,39 +18,44 @@
$ gem install kaltura_box
## Usage
- # For the Entry class
- class Video < ActiveRecord::Base
- include KalturaBox::Entry
- end
+```ruby
+# For the Entry class
+class Video < ActiveRecord::Base
+ include KalturaBox::Entry
+end
- # Category class
- class Category < ActiveRecord::Base
- include KalturaBox::Category
- end
+# Category class
+class Category < ActiveRecord::Base
+ include KalturaBox::Category
+end
- # Entry listing from Kaltura
- Video.video_list
+# Entry listing from Kaltura
+Video.video_list
- # Create videos based on Kaltura entries
- Video.update_all_videos!
+# Search
+Video.video_list("search string here")
- # Retrieve a kaltura entry
- video = Video.new(entry_id: "0_7ivwzhbh")
- video.get
+# Create videos based on Kaltura entries
+Video.update_all_videos!
- # Tagging
- video.set_tags = "noodles, food, yummy" # Create a new set of tags
- video.add_tags = "rice, fruits" # Add more tags to the existing tag list
- video.add_tag("bacon") # Add a single tag
- video.get_tags # Retrieve tags
+# Retrieve a kaltura entry
+video = Video.new(entry_id: "0_7ivwzhbh")
+video.get
- # Kaltura Metadata
- video.set(name: "bla", description: "blablabla")
- video.set_name = "bla"
- video.set_description = "blablabla"
+# Tagging
+video.set_tags = "noodles, food, yummy" # Create a new set of tags
+video.add_tags = "rice, fruits" # Add more tags to the existing tag list
+video.add_tag("bacon") # Add a single tag
+video.get_tags # Retrieve tags
+
+# Kaltura Metadata
+video.set(name: "bla", description: "blablabla")
+video.set_name = "bla"
+video.set_description = "blablabla"
+```
## Contributing
1. Fork it ( https://github.com/[my-github-username]/kaltura_box/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)