Skip to content

Commit 19fccc2

Browse files
authored
Fixing grammar, formatting errors and typos
- Fixed typos, grammatical errors and formatting. - Updated copyright year
1 parent e7eb4e1 commit 19fccc2

1 file changed

Lines changed: 23 additions & 21 deletions

File tree

README.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<img src="https://user-images.githubusercontent.com/12621342/35959365-41f352b0-0ce0-11e8-8a5b-05ad054ea378.png">
55
</p>
66

7-
> The node version of github-profile-summary which is inspired by tipsy' [github-profile-summary](https://github.com/tipsy/github-profile-summary)
7+
> The node version of github-profile-summary which is inspired by tipsy's [github-profile-summary](https://github.com/tipsy/github-profile-summary)
88
99
Site: https://gh-profile-summary.teamsz.xyz
1010

@@ -13,42 +13,42 @@ Site: https://gh-profile-summary.teamsz.xyz
1313
- Vue
1414
- Chart.js
1515
- Koa
16-
- Github graphql api
16+
- GitHub GraphQL API
1717

1818
## Screenshot
1919

2020
### Cool & beautiful profile list
2121

2222
![](https://user-images.githubusercontent.com/12621342/35951697-89e3338e-0cb7-11e8-9986-dc258f257b97.png)
2323

24-
### Share system & Save your profile as Image
24+
### Share system & save your profile as an image
2525

2626
![](https://user-images.githubusercontent.com/12621342/35951773-d1c9cf50-0cb7-11e8-80b2-08ae7d876533.png)
2727

2828
## Setup
2929

30-
First generate a token at https://github.com/settings/tokens
30+
First, generate a token over at: https://github.com/settings/tokens
3131

32-
Then You need to create a `.env` file in the project folder.
32+
Then you need to create a `.env` file in the project folder.
3333

34-
The `.env` file looks like:
34+
The `.env` file looks like this:
3535

3636
```env
37-
GH_TOKEN=Your token here
38-
JWT_SECRET=Any string
39-
KOA_PORT=8888
40-
HTTPS=false
37+
GH_TOKEN = Your token here
38+
JWT_SECRET = Any string
39+
KOA_PORT = 8888
40+
HTTPS = false
4141
```
4242

43-
> KOA_PORT can be any port you like which is available.
43+
> KOA_PORT can be any available port that you like.
4444
45-
**If you set `HTTPS=true`, then the websocket will connect the 443 port, it's useful for https production.**
45+
**If you set `HTTPS = true`, then the websocket will connect via port 443. This is particularly useful for https production.**
4646

4747
## Local run
4848

4949
### Node.js
5050

51-
> You need to have node environment!
51+
> You need to have a node environment!
5252
5353
### Install
5454

@@ -65,13 +65,15 @@ npm run build
6565
npm start
6666
```
6767

68-
**Notice:** 8888 is the `KOA_PORT` in `.env` file
68+
**Notice:** `8888` is the `KOA_PORT` in the `.env` file.
6969

70-
And then open the link `http://localhost:8888`, Done.
70+
Access the application via: http://localhost:8888
71+
72+
Done.
7173

7274
### Docker
7375

74-
> You need to have docker environment!
76+
> You need to have a docker environment!
7577
7678
### Build
7779

@@ -85,9 +87,11 @@ docker build -t github-profile .
8587
docker run -it --rm --name github-profile -p 8888:8888 github-profile
8688
```
8789

88-
**Notice:** 8888 is the `KOA_PORT` in `.env` file
90+
**Notice:** `8888` is the `KOA_PORT` in the `.env` file.
91+
92+
Access the application via: http://localhost:8888
8993

90-
And then open the link `http://localhost:8888`, Done.
94+
Done.
9195

9296
## TODOS
9397

@@ -100,6 +104,4 @@ And then open the link `http://localhost:8888`, Done.
100104

101105
[MIT](http://opensource.org/licenses/MIT)
102106

103-
Copyright (c) 2018 Molunerfinn
104-
105-
107+
Copyright (c) 2019 Molunerfinn

0 commit comments

Comments
 (0)