Skip to content

Commit ae775e8

Browse files
updated the readme notes
1 parent dcfbc63 commit ae775e8

File tree

3 files changed

+45
-43
lines changed

3 files changed

+45
-43
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ A React based github-activity component.
33

44
Inspired by [this repository](https://github.com/caseyscarborough/github-activity) I wanted to develop a github activity component that was much simpler to setup in a react project.
55

6+
It is recommended to pass the client ID and Secret when using the github API to prevent encountering the limit. learn more [here](https://developer.github.com/v3/#oauth2-keysecret)
7+
68
## Demo
79
See in action on [my website](http://piotr.codes/)
810
## Installation
@@ -47,7 +49,7 @@ class Example extends React.Component {
4749
const userName = 'piotrromanowski'
4850
const avatarUrl = ''
4951
const events = [/* data result from https://api.github.com/users/${userName}/events */];
50-
52+
5153
return (
5254
<GitHubFeed
5355
fullName={fullName} // Provide Full Name as displayed on GitHub

demo/src/index.js

+41-42
Original file line numberDiff line numberDiff line change
@@ -5,49 +5,48 @@ import Component from '../../src'
55

66
let Demo = React.createClass({
77
render() {
8-
98
const eventList = [{
10-
"id": "3889022637",
11-
"type": "WatchEvent",
12-
"actor": {
13-
"id": 5794815,
14-
"login": "piotrromanowski",
15-
"gravatar_id": "",
16-
"url": "https://api.github.com/users/piotrromanowski",
17-
"avatar_url": "https://avatars.githubusercontent.com/u/5794815?"
18-
},
19-
"repo": {
20-
"id": 42841092,
21-
"name": "andrewngu/sound-redux",
22-
"url": "https://api.github.com/repos/andrewngu/sound-redux"
23-
},
24-
"payload": {
25-
"action": "started"
26-
},
27-
"public": true,
28-
"created_at": "2016-04-14T14:22:35Z"
29-
},
30-
{
31-
"id": "3880483468",
32-
"type": "WatchEvent",
33-
"actor": {
34-
"id": 5794815,
35-
"login": "piotrromanowski",
36-
"gravatar_id": "",
37-
"url": "https://api.github.com/users/piotrromanowski",
38-
"avatar_url": "https://avatars.githubusercontent.com/u/5794815?"
39-
},
40-
"repo": {
41-
"id": 2269353,
42-
"name": "desandro/imagesloaded",
43-
"url": "https://api.github.com/repos/desandro/imagesloaded"
44-
},
45-
"payload": {
46-
"action": "started"
47-
},
48-
"public": true,
49-
"created_at": "2016-04-12T22:21:45Z"
50-
}];
9+
"id": "3889022637",
10+
"type": "WatchEvent",
11+
"actor": {
12+
"id": 5794815,
13+
"login": "piotrromanowski",
14+
"gravatar_id": "",
15+
"url": "https://api.github.com/users/piotrromanowski",
16+
"avatar_url": "https://avatars.githubusercontent.com/u/5794815?"
17+
},
18+
"repo": {
19+
"id": 42841092,
20+
"name": "andrewngu/sound-redux",
21+
"url": "https://api.github.com/repos/andrewngu/sound-redux"
22+
},
23+
"payload": {
24+
"action": "started"
25+
},
26+
"public": true,
27+
"created_at": "2016-04-14T14:22:35Z"
28+
},
29+
{
30+
"id": "3880483468",
31+
"type": "WatchEvent",
32+
"actor": {
33+
"id": 5794815,
34+
"login": "piotrromanowski",
35+
"gravatar_id": "",
36+
"url": "https://api.github.com/users/piotrromanowski",
37+
"avatar_url": "https://avatars.githubusercontent.com/u/5794815?"
38+
},
39+
"repo": {
40+
"id": 2269353,
41+
"name": "desandro/imagesloaded",
42+
"url": "https://api.github.com/repos/desandro/imagesloaded"
43+
},
44+
"payload": {
45+
"action": "started"
46+
},
47+
"public": true,
48+
"created_at": "2016-04-12T22:21:45Z"
49+
}];
5150

5251
return (<div>
5352
<h1>react-github-activity Demo</h1>

package.json

+1
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
"license": "MIT",
3434
"repository": "https://github.com/piotrromanowski/react-github-activity",
3535
"keywords": [
36+
"react",
3637
"react-component",
3738
"github",
3839
"activity"

0 commit comments

Comments
 (0)