Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

updated readme file

git-svn-id: http://svn.addictedtonew.com/public/gems/mirrored@83 fe7eae16-9a24-0410-a59d-9e59979e88be
  • Loading branch information...
commit 083b930e2e7dcab8a3806bdaa39f8d017cf47663 1 parent 0996735
jnunemaker authored
Showing with 20 additions and 1 deletion.
  1. +20 −1 README.txt
View
21 README.txt
@@ -1 +1,20 @@
-README
+= Mirrored
+
+Mirrored is a really easy to use wrapper for the delicious api (http://del.icio.us/help/api) and magnolia's mirrored version (http://wiki.ma.gnolia.com/Mirror%27d_API).
+
+== Install
+
+ sudo gem install mirrored -y
+
+== Usage
+
+1. Setup your connection to either :magnolia or :delicious.
+
+ Mirrored::Base.establish_connection(:magnolia, 'jnunemaker', 'password')
+
+2. Work the mirrored classes (Post, Tag, Update and Date)
+
+ # => posts tagged ruby
+ Mirrored::Post.find(:get, :tag => 'ruby')
+
+You can also manipulate tags, find out when your last update was and see information about your posting habits. See the rubyforge page for more information (http://mirrored.rubyforge.org).
Please sign in to comment.
Something went wrong with that request. Please try again.