Skip to content

Commit 62c87d5

Browse files
ElectronicsArchiverElectronicsArchiver
authored
README Formatting (#118)
* Formatted README * Adjusted Spacing
1 parent 35def6d commit 62c87d5

File tree

4 files changed

+237
-29
lines changed

4 files changed

+237
-29
lines changed

‎Documentation/Building.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
2+
# Building
3+
4+
*How to setup and compile the project.*
5+
6+
<br>
7+
8+
## Docker
9+
10+
You can also use **[Docker]** to <br>
11+
compile & run the project.
12+
13+
<br>
14+
<br>
15+
16+
## Steps
17+
18+
- Clone the repository
19+
20+
```shell
21+
git clone https://github.com/tipsy/profile-summary-for-github.git
22+
```
23+
24+
- Navigate to the root folder
25+
26+
```shell
27+
cd profile-summary-for-github
28+
```
29+
30+
- Install the dependencies
31+
32+
```shell
33+
mvn install
34+
```
35+
36+
- Compile the source code
37+
38+
```shell
39+
java -jar target/profile-summary-for-github-jar-with-dependencies.jar
40+
```
41+
42+
<br>
43+
44+
45+
<!----------------------------------------------------------------------------->
46+
47+
[Docker]: Docker.md
48+

‎Documentation/Docker.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
2+
# Docker
3+
4+
*How to use this project with docker.*
5+
6+
<br>
7+
8+
## Building
9+
10+
*How to compile the source code.*
11+
12+
<br>
13+
14+
- Clone the repository
15+
16+
```shell
17+
git clone https://github.com/tipsy/profile-summary-for-github.git
18+
```
19+
20+
- Navigate to the root folder
21+
22+
```shell
23+
cd profile-summary-for-github
24+
```
25+
26+
- Compile the source code
27+
28+
```shell
29+
docker build -t profile-summary-for-github
30+
```
31+
32+
<br>
33+
<br>
34+
35+
## Running
36+
37+
*How to start the compiled project.*
38+
39+
<br>
40+
41+
### Without Token
42+
43+
```shell
44+
docker run \
45+
-it \
46+
--rm \
47+
--name profile-summary-for-github \
48+
-p 7070:7070 profile-summary-for-github
49+
```
50+
51+
<br>
52+
53+
### With Token
54+
55+
```shell
56+
docker run \
57+
-it \
58+
--rm \
59+
--name profile-summary-for-github \
60+
-p 7070:7070 \
61+
-e "API_TOKENS=<My Token A>,<My Token B>" profile-summary-for-github
62+
```
63+
64+
<br>
65+
66+
### Interface
67+
68+
You can access it at http://localhost:7070
69+
70+
<br>

‎Documentation/Usage.md

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
2+
# Usage
3+
4+
*How to configure the project.*
5+
6+
<br>
7+
8+
## API Token
9+
10+
*The access token to GitHubs API.*
11+
12+
<br>
13+
14+
### Without
15+
16+
If no api token is set, you only get `~50 requests / hour`.
17+
18+
<br>
19+
20+
### With
21+
22+
To run the app with an api-token, first **[Generate A Token]**.
23+
24+
Provide the token in the following way:
25+
26+
```shell
27+
java \
28+
-Dapi-tokens=your-token \
29+
-jar target/profile-summary-for-github-jar-with-dependencies.jar
30+
```
31+
32+
*You can use a comma-separated list* <br>
33+
*of tokens to increase your rate-limit.*
34+
35+
<br>
36+
<br>
37+
38+
## Parameters
39+
40+
*Command line options you can set.*
41+
42+
<br>
43+
44+
### Unrestricted
45+
46+
You can allow the building of any GitHub <br>
47+
profile by passing `-Dunrestricted=true` :
48+
49+
```shell
50+
java \
51+
-Dunrestricted=true \
52+
-jar target/profile-summary-for-github-jar-with-dependencies.jar
53+
```
54+
55+
<br>
56+
57+
### Free Threshold
58+
59+
You can set when the app should require <br>
60+
the user to star the GitHub repository.
61+
62+
*Pass the number of remaining requests at which the* <br>
63+
*cutoff should kick in, as seen in the following example:*
64+
65+
```shell
66+
java \
67+
-Dfree-requests-cutoff=1000 \
68+
-jar target/profile-summary-for-github-jar-with-dependencies.jar
69+
```
70+
71+
<br>
72+
73+
### Google Tag Manager
74+
75+
You can enable this feature by passing the `gtm-id`.
76+
77+
```shell
78+
java \
79+
-Dgtm-id=GTM-XXXXXX \
80+
-jar target/profile-summary-for-github-jar-with-dependencies.jar
81+
```
82+
83+
<br>
84+
85+
86+
<!----------------------------------------------------------------------------->
87+
88+
[Generate A Token]: https://github.com/settings/tokens

‎README.md

+31-29
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,46 @@
1-
# profile-summary-for-github
21

3-
## live at [https://profile-summary-for-github.com/](https://profile-summary-for-github.com/)
2+
# Profile Summary   [![Badge License]][License]
43

5-
## screenshot
6-
![screenshot](https://user-images.githubusercontent.com/1521451/34072014-4451dbf6-e280-11e7-90a7-32ad1f313541.PNG)
4+
*A tool to visualize your **GitHub** presence.*
75

8-
## run locally
9-
* `git clone https://github.com/tipsy/profile-summary-for-github.git`
10-
* `cd profile-summary-for-github`
11-
* `mvn install`
12-
* `java -jar target/profile-summary-for-github-jar-with-dependencies.jar`
6+
<br>
137

14-
If no api-token is set, you only get ~50 requests/hour
8+
<div align = center>
159

16-
To run the app with an api-token, first generate a token at
17-
[https://github.com/settings/tokens](https://github.com/settings/tokens),
18-
then launch the jar with the token:
10+
---
1911

20-
* `java -Dapi-tokens=your-token -jar target/profile-summary-for-github-jar-with-dependencies.jar`
12+
[![Button Demo]][Demo]   
13+
[![Button Building]][Building]   
14+
[![Button Usage]][Usage] 
2115

22-
You can use a comma-separated list of tokens to increase your rate-limit
16+
---
2317

24-
You can build a profile summary for any GitHub profile using `-Dunrestricted=true`:
18+
<br>
2519

26-
* `java -Dunrestricted=true -jar target/profile-summary-for-github-jar-with-dependencies.jar`
20+
<img
21+
src = 'https://user-images.githubusercontent.com/1521451/34072014-4451dbf6-e280-11e7-90a7-32ad1f313541.PNG'
22+
width = 800
23+
/>
2724

28-
You can set when the app should require user-starring by passing `free-requests-cutoff`
29-
Passing 1000 will require the app to require starring if there are less than 1000 requests left:
25+
</div>
3026

31-
* `java -Dfree-requests-cutoff=1000 -jar target/profile-summary-for-github-jar-with-dependencies.jar`
3227

33-
You can enable Google Tag Manager on your instance by setting `gtm-id`:
28+
<!----------------------------------------------------------------------------->
3429

35-
* `java -Dgtm-id=GTM-XXXXXX -jar target/profile-summary-for-github-jar-with-dependencies.jar`
30+
[Demo]: https://profile-summary-for-github.com/
3631

37-
## run locally with docker
32+
[Building]: Documentation/Building.md
33+
[License]: LICENSE
34+
[Usage]: Documentation/Usage.md
3835

39-
* `git clone https://github.com/tipsy/profile-summary-for-github.git`
40-
* `cd profile-summary-for-github`
41-
* `docker build -t profile-summary-for-github .`
42-
* `docker run -it --rm --name profile-summary-for-github -p 7070:7070 profile-summary-for-github`
43-
* 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`
44-
* browse to http://localhost:7070
36+
37+
<!--------------------------------[ Badges ]----------------------------------->
38+
39+
[Badge License]: https://img.shields.io/badge/License-Apache_2.0-D22128?style=for-the-badge
40+
41+
42+
<!-------------------------------[ Buttons ]----------------------------------->
43+
44+
[Button Building]: https://img.shields.io/badge/Building-7952B3?style=for-the-badge&logoColor=white&logo=AzureArtifacts
45+
[Button Usage]: https://img.shields.io/badge/Usage-239120?style=for-the-badge&logoColor=white&logo=GitBook
46+
[Button Demo]: https://img.shields.io/badge/Demo-0091BD?style=for-the-badge&logoColor=white&logo=AppleArcade

0 commit comments

Comments
 (0)