Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Documentation

  • Loading branch information...
commit 3d33814ef99fe145b1924161a87e81e0d1c0bf3d 1 parent 459e4b4
@atd atd authored
Showing with 25 additions and 15 deletions.
  1. +25 −15 README.rdoc
View
40 README.rdoc
@@ -3,23 +3,27 @@ Social Stream is a plugin for Ruby on Rails. It provides your application with s
features and activity streams.
== Social networking
-Social networks are the new paradigm on web application design. Social networking platforms stand
-among the most popular websites, while many content oriented applications support social networking
-features in order to improve engagement, enhance user awareness and stimulate communities around
-the website.
+Social networks are a new paradigm on web application design. Social networking platforms stand
+among the most popular websites, while many content oriented applications are supporting social
+networking features in order to improve engagement, enhance user awareness and stimulate communities
+around the website.
-SocialStream is based in {Social Network Analysis}[http://en.wikipedia.org/wiki/Social_network]
-concepts and methods, including social entities (actors), ties and relations. It provides a
-new tie-based access control model.
+{Social Stream}[http://github.com/atd/social_stream] is based in
+{Social Network Analysis}[http://en.wikipedia.org/wiki/Social_network] concepts and methods,
+including social entities (actors), ties and relations.
+It also provides a new tie-based access control model.
== Activity Streams
{Activity Streams}[http://activitystrea.ms/] is a format for syndicating social activities around the web. It has already been adopted by some of the major social networking platforms.
-Social stream provides a database schema based on the {Activity Streams specification}[http://activitystrea.ms/head/activity-schema.html], leading your application towards a well-known compatible data model design.
+{Social Stream}[http://github.com/atd/social_stream] provides a database schema based on the
+{Activity Streams specification}[http://activitystrea.ms/head/activity-schema.html], leading your
+application towards a well-known compatible data model design.
= Installation
-SocialStream requires Rails 3. Install it with:
+{Social Stream}[http://github.com/atd/social_stream] requires Rails 3. Install it in
+a Rails application with:
rails plugin install http://github.com/atd/social_stream.git
@@ -27,20 +31,26 @@ And run:
rails generate social_stream:install
-This will generate a migration providing the SocialStream database schema and create a configuration
+This will generate a migration providing the Social Stream database schema and create a configuration
file for SocialStream.
-== Actors and ActivityObjects
+== Actors and Activity Objects
-SocialStream relies in other authentication solutions like
+{Social Stream}[http://github.com/atd/social_stream] relies in other authentication solutions like
Authlogic[http://github.com/binarylogic/authlogic] or Devise[http://github.com/plataformatec/devise].
-You must include an <tt>actor_id</tt> column in the migration. Then add your model to
+You must include an <tt>actor_id</tt> column in the user's migration. Then add user to
<tt>config/initializers/social_stream.rb</tt>
-You must do the same with ActivityObjects, like posts, comments or photos. Don't forget to add
+You must do the same with Activity Objects, like posts, comments or photos. Don't forget to add
a <tt>activity_object_id</tt> column in the migration and add them to the initializer.
+= Documentation
+
+{Social Stream documentation}[http://rdoc.info/github/atd/social_stream/frames] is available at
+{rdoc.info}[http://rdoc.info/]
+
= Discussion
-SocialStream is in an early stage of development. Feel free to add an issue or send a message.
+{Social Stream}[http://github.com/atd/social_stream] is at an early stage of development.
+Feel free to add an issue or send a message at github[http://github.com/atd/social_stream].
Please sign in to comment.
Something went wrong with that request. Please try again.