Skip to content

Commit

Permalink
add detail to README
Browse files Browse the repository at this point in the history
- add: gem version badge
- add: more detailed return value
  • Loading branch information
leesharma committed Apr 15, 2015
1 parent 4a55180 commit 6064fc8
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
rescuetime (under development)
==========

[![Gem](https://img.shields.io/gem/v/rescuetime.svg?style=flat-square)](https://rubygems.org/gems/rescuetime)
[![Coverage](http://img.shields.io/codeclimate/coverage/github/leesharma/rescuetime.svg?style=flat-square)](https://codeclimate.com/github/leesharma/rescuetime)
[![Quality](http://img.shields.io/codeclimate/github/leesharma/rescuetime.svg?style=flat-square)](https://codeclimate.com/github/leesharma/rescuetime)
[![Build](https://img.shields.io/travis/leesharma/rescuetime.svg?style=flat-square)](https://travis-ci.org/leesharma/rescuetime)
Expand Down Expand Up @@ -45,8 +46,21 @@ require 'rescuetime'

@client = Rescuetime::Client.new(api_key: <YOUR_API_KEY>)

@client.activities
# => Returns a list of activities
@client.activities # Returns a list of activities, ordered by "rank"

@client.activities.class # => Array
@client.activities.count # => 41

@client.activities[0].class # => Hash
@client.activities[0]
# => {
# :rank=>1,
# :time_spent_seconds=>5307,
# :number_of_people=>1,
# :activity=>"github.com",
# :category=>"General Software Development",
# :productivity=>2
# }
```

## Development
Expand Down

0 comments on commit 6064fc8

Please sign in to comment.