Skip to content

Update README.rdoc #494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thiszsachin wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.rdoc #494

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions README.rdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Social Stream: a framework for building social network websites
= Social Stream: a framework for building social network websites.

Social Stream is an engine for Ruby on Rails. It provides a robust and flexible framework
with {social networking}[http://en.wikipedia.org/wiki/Social_network] features and {activity streams}[http://activitystrea.ms/] for building websites.
Expand All @@ -7,22 +7,21 @@ with {social networking}[http://en.wikipedia.org/wiki/Social_network] features a
{<img src="https://codeclimate.com/github/ging/social_stream.png" />}[https://codeclimate.com/github/ging/social_stream]
{<img src="https://secure.travis-ci.org/ging/social_stream.png" />}[http://travis-ci.org/ging/social_stream]

= Social Stream components
= Social Stream components-

Social Stream is divided into components. Developers can customize their social
network with the functionalities they need for each case. Check {current Social Stream components in Social Stream's website}[http://social-stream.dit.upm.es/started#components]

= Installation

= Installation-
There is a {detailed guide in Social Stream's website}[http://social-stream.dit.upm.es/started] on how to get started, install Social Stream in your Rails application and customize it.

= Documentation
= Documentation-

{Social Stream's wiki}[https://github.com/ging/social_stream/wiki] covers topics such as deployment howtos, development tips or an explanation of the database schema.

Furthermore, {Social Stream's code documentation is available at rdoc.info}[http://rubydoc.info/gems/social_stream/frames]. Most of the stuff is in {the base gem}[http://rubydoc.info/gems/social_stream-base/frames].

= Discussion and contribution
= Discussion and contribution-

If you have any questions or issues regarding Social Stream usage, {Social Stream's Google group}[http://groups.google.com/group/social-stream] is a perfect place to share them. Other experienced users of Social Stream will be willing to help you. There exist also a {social-stream tag in StackOverflow}[http://stackoverflow.com/questions/tagged/social-stream]

Expand Down