Skip to content

Commit

Permalink
docs draft
Browse files Browse the repository at this point in the history
  • Loading branch information
iamstarkov committed Aug 14, 2015
1 parent 1f47a41 commit f4a599c
Showing 1 changed file with 26 additions and 13 deletions.
39 changes: 26 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,41 @@
```js
import tweetsStats from 'tweets-stats';

tweetsStats('unicorns'); // unicorns
stats([/**/]);
/* {
"tweets": 192,
"own": 90,
"replies": 66,
"retweets": 36,
"ownPercentage": 46.88,
"repliesPercentage": 34.38,
"retweetsPercentage": 18.75,
"retweeted": 73,
"favorited": 471,
"retweetedKpi": 0.81,
"favoritedKpi": 5.23
} */
```

## API

### tweetsStats(input, [options])
### tweetsStats(tweets)

#### input
Return `Object {
tweets, own, replies, retweets,
ownPercentage, repliesPercentage, retweetsPercentage,
retweeted, favorited,
retweetedKpi, favoritedKpi
}`

*Required*
Type: `String`

Lorem ipsum.
#### tweets

#### options

##### foo
*Required*
Type: `Array`

Type: `Boolean`
Default: `false`
Array of tweets from Twitter API. Take a look at [get-tweets][get-tweets].

Lorem ipsum.
[get-tweets]: https://github.com/iamstarkov/get-tweets

## License

Expand Down

0 comments on commit f4a599c

Please sign in to comment.