README.md in git-trend-1.0.1 vs README.md in git-trend-1.0.2

- old
+ new

@@ -14,59 +14,66 @@ Ruby versions is 2.0 or later. ## Installation Add this line to your application's Gemfile: + gem 'git-trend' And then execute: - $bundle + $ bundle + Or install it yourself as: + $ gem install git-trend ## Usage Of a gem Require it if you haven't: require 'git-trend' ### Fetch trending - repos = GitTrend.get - repos.each do |r| - puts "#{r.name} (#{r.star_count} stargazers)" - puts "--- #{r.description}\n\n" - end - - # => - # jayphelps/git-blame-someone-else (625 stargazers) - # --- Blame someone else for your bad code. - # - # FreeCodeCamp/FreeCodeCamp (574 stargazers) - # --- The http://FreeCodeCamp.com open source codebase and curriculum. Learn to # code and help nonprofits. - # - # p-e-w/maybe (519 stargazers) - # --- See what a program does before deciding whether you really want it to happen. - # ... +```ruby +repos = GitTrend.get +repos.each do |r| + puts "#{r.name} (#{r.star_count} stargazers)" + puts "--- #{r.description}\n\n" +end +# => +# jayphelps/git-blame-someone-else (625 stargazers) +# --- Blame someone else for your bad code. +# +# FreeCodeCamp/FreeCodeCamp (574 stargazers) +# --- The http://FreeCodeCamp.com open source codebase and curriculum. Learn to # code and help nonprofits. +# +# p-e-w/maybe (519 stargazers) +# --- See what a program does before deciding whether you really want it to happen. +# ... +``` + ### Use language and since options - # language - GitTrend.get('ruby') - GitTrend.get(:ruby) +```ruby +# language +GitTrend.get('ruby') +GitTrend.get(:ruby) - # since - GitTrend.get(since: :weekly) - GitTrend.get(since: :week) - GitTrend.get(since: :w) - - # language and since - GitTrend.get('ruby', 'weekly') - GitTrend.get(:ruby, :weekly) - GitTrend.get(language: :ruby, since: :weekly) +# since +GitTrend.get(since: :weekly) +GitTrend.get(since: :week) +GitTrend.get(since: :w) +# language and since +GitTrend.get('ruby', 'weekly') +GitTrend.get(:ruby, :weekly) +GitTrend.get(language: :ruby, since: :weekly) +``` + ### Show enable languages GitTrend.languages ## Usage Of a command line tool @@ -148,20 +155,22 @@ ... ``` ### Fetch weekly/monthly trending - git trend -s weekly - git trend -s week - git trend -s w - - or - - git trend -s monthly - git trend -s month - git trend -s m +```ruby +git trend -s weekly +git trend -s week +git trend -s w +or + +git trend -s monthly +git trend -s month +git trend -s m +``` + e.g.: ``` $ git trend -s weekly No. Name Lang Star Description @@ -221,10 +230,10 @@ ## Contributing -1. Fork it ( https://github.com/[my-github-username]/git-trend/fork ) +1. Fork it ( https://github.com/rochefort/git-trend/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create a new Pull Request