diff --git a/README.md b/README.md index 06c15641..00d5843c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,28 @@ -Make sure you have jekyll installed, and run: +RubyGems Guides +=============== + +An effort to provide awesome documentation for the RubyGems ecosystem. + +Goals +===== + +* Be the definitive place for RubyGems knowledge +* Help out those new to RubyGems get started and get things done +* Make it easy to contribute more guides + +Todo +==== + +* Port content from docs.rubygems.org +* Port content from rubygems.org/pages/docs +* Port content from help.rubygems.org knowledge base +* Find lots of StackOverflow/ruby-talk questions and get their common answers in here +* Fill out more guides! + +Setup +===== + +Make sure you have jekyll installed (`gem install jekyll`), and run: $ jekyll --server