|
1 |
| -# github-profile-summary |
| 1 | +# profile-summary-for-github |
2 | 2 |
|
3 |
| -## live at [https://github-profile-summary.com/](https://github-profile-summary.com/) |
| 3 | +## live at [https://profile-summary-for-github.com/](https://profile-summary-for-github.com/) |
4 | 4 |
|
5 | 5 | ## screenshot
|
6 | 6 | 
|
7 | 7 |
|
8 | 8 | ## run locally
|
9 |
| -* `git clone https://github.com/tipsy/github-profile-summary.git` |
10 |
| -* `cd github-profile-summary` |
| 9 | +* `git clone https://github.com/tipsy/profile-summary-for-github.git` |
| 10 | +* `cd profile-summary-for-github` |
11 | 11 | * `mvn install`
|
12 |
| -* `java -jar target/github-profile-summary-jar-with-dependencies.jar` |
| 12 | +* `java -jar target/profile-summary-for-github-jar-with-dependencies.jar` |
13 | 13 |
|
14 | 14 | If no api-token is set, you only get ~50 requests/hour
|
15 | 15 |
|
16 | 16 | To run the app with an api-token, first generate a token at
|
17 | 17 | [https://github.com/settings/tokens](https://github.com/settings/tokens),
|
18 | 18 | then launch the jar with the token:
|
19 | 19 |
|
20 |
| -* `java -Dapi-tokens=your-token -jar target/github-profile-summary-jar-with-dependencies.jar` |
| 20 | +* `java -Dapi-tokens=your-token -jar target/profile-summary-for-github-jar-with-dependencies.jar` |
21 | 21 |
|
22 | 22 | You can use a comma-separated list of tokens to increase your rate-limit
|
23 | 23 |
|
24 | 24 | You can build a profile summary for any GitHub profile using `-Dunrestricted=true`:
|
25 | 25 |
|
26 |
| -* `java -Dunrestricted=true -jar target/github-profile-summary-jar-with-dependencies.jar` |
| 26 | +* `java -Dunrestricted=true -jar target/profile-summary-for-github-jar-with-dependencies.jar` |
27 | 27 |
|
28 | 28 | You can enable Google Tag Manager on your instance by setting `gtm-id`:
|
29 | 29 |
|
30 |
| -* `java -Dgtm-id=GTM-XXXXXX -jar target/github-profile-summary-jar-with-dependencies.jar` |
| 30 | +* `java -Dgtm-id=GTM-XXXXXX -jar target/profile-summary-for-github-jar-with-dependencies.jar` |
31 | 31 |
|
32 | 32 | ## run locally with docker
|
33 | 33 |
|
34 |
| -* `git clone https://github.com/tipsy/github-profile-summary.git` |
35 |
| -* `cd github-profile-summary` |
36 |
| -* `docker build -t github-profile-summary .` |
37 |
| -* `docker run -it --rm --name github-profile-summary -p 7070:7070 github-profile-summary` |
38 |
| -* OR with a token `docker run -it --rm --name github-profile-summary -p 7070:7070 -e "API_TOKENS=mytoken1,mytoken2" github-profile-summary` |
| 34 | +* `git clone https://github.com/tipsy/profile-summary-for-github.git` |
| 35 | +* `cd profile-summary-for-github` |
| 36 | +* `docker build -t profile-summary-for-github .` |
| 37 | +* `docker run -it --rm --name profile-summary-for-github -p 7070:7070 profile-summary-for-github` |
| 38 | +* OR with a token `docker run -it --rm --name profile-summary-for-github -p 7070:7070 -e "API_TOKENS=mytoken1,mytoken2" profile-summary-for-github` |
39 | 39 | * browse to http://localhost:7070
|
0 commit comments