Skip to content
This repository was archived by the owner on Jun 8, 2020. It is now read-only.

Commit b398e81

Browse files
committed
Improve trackers documentation
1 parent 4135f66 commit b398e81

File tree

1 file changed

+23
-40
lines changed

1 file changed

+23
-40
lines changed

README.md

+23-40
Original file line numberDiff line numberDiff line change
@@ -30,39 +30,15 @@ $ git clone https://github.com/SamyPesse/reportr.git && cd ./reportr
3030

3131
#### Configuration
3232

33-
Configure the Reportr instance using Heroku config vars or define these variables in a **.env** file for local use:
33+
Configure the Reportr instance using Heroku config vars or define these variables in a **.env** file for local use.
34+
Configure the differents trackers using Trackers list below.
3435

3536
```
3637
# Host name
3738
HOST
3839
3940
# Express Secret session
4041
SESSION_SECRET
41-
42-
# Foursquare oAuth
43-
# Callback url is {HOST}/auth/foursquare/callback
44-
FOURSQUARE_CLIENTID
45-
FOURSQUARE_CLIENTSECRET
46-
47-
# GitHub oAuth
48-
# Callback url is {HOST}/auth/github/callback
49-
GITHUB_CLIENTID
50-
GITHUB_CLIENTSECRET
51-
52-
# Facebook oAuth
53-
# Callback url is {HOST}/auth/facebook/callback
54-
FACEBOOK_CLIENTID
55-
FACEBOOK_CLIENTSECRET
56-
57-
# Twitter oAuth
58-
# Callback url is {HOST}/auth/twitter/callback
59-
TWITTER_CLIENTID
60-
TWITTER_CLIENTSECRET
61-
62-
# Runkeeper oAuth
63-
# Callback url is {HOST}/auth/runkeeper/callback
64-
RUNKEEPER_CLIENTID
65-
RUNKEEPER_CLIENTSECRET
6642
```
6743

6844
#### Create your application and deploy it
@@ -121,21 +97,28 @@ make deploy
12197

12298
## Trackers
12399

124-
Here is a list of trackers, I already built:
125-
126-
* Web Navigation: track web navigation using a Chrome extension
127-
* Instance ping: ping state of the Reportr instance
128-
* Foursquare: track checkins
129-
* GitHub: track coding activity on GitHub
130-
* Facebook: track relations on Facebook (using Realtime API)
131-
* Twitter: track twitter activity (tweets, mentions, ...)
132-
* Runkeeper: track running activity
133-
134-
And more to come:
100+
| State | Name | Description | Configuration |
101+
|:-----:| ------------------- | ----------------- | ----------------- |
102+
| X | *Web Navigation* | Track web navigation using a Chrome extension | |
103+
| X | *Ping* | Ping state of the Reportr instance | |
104+
| X | *Foursquare* | Track your checkins | Callback url is /auth/foursquare/callback |
105+
|||| FOURSQUARE_CLIENTID |
106+
|||| FOURSQUARE_CLIENTSECRET |
107+
| X | *GitHub* | Track coding activity on GitHub | Callback url is /auth/github/callback |
108+
|||| GITHUB_CLIENTID |
109+
|||| GITHUB_CLIENTSECRET |
110+
| X | *Facebook* | Track relations on Facebook | Callback url is /auth/facebook/callback |
111+
|||| FACEBOOK_CLIENTID |
112+
|||| FACEBOOK_CLIENTSECRET |
113+
| X | *Twitter* | Track twitter activity (tweets, mentions, ...) | Callback url is /auth/twitter/callback |
114+
|||| TWITTER_CLIENTID |
115+
|||| TWITTER_CLIENTSECRET |
116+
| X | *Runkeeper* | Track fitness activity from Runkeeper | Callback url is /auth/runkeeper/callback |
117+
|||| RUNKEEPER_CLIENTID |
118+
|||| RUNKEEPER_CLIENTSECRET |
119+
| - | *Fitbit* | Track fitness activity from Fitbit | |
120+
| - | *Temperature* | Track the temperature in a room (using tessel.io) | |
135121

136-
* Fitbit
137-
* Hardware:
138-
* Track the temperature in a room (using tessel.io)
139122

140123
## APIs
141124

0 commit comments

Comments
 (0)