Skip to content

Commit 679d914

Browse files
committed
readme
1 parent d090139 commit 679d914

2 files changed

Lines changed: 7 additions & 6 deletions

File tree

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ In the GitQ folder,
2424
"background.js" file contains all the source code related to analyzing repository and displaying badges.
2525
"manifest.json" file includes the url that triggers start of GitQ.
2626

27-
## Steps to install GitQ:
27+
## Steps to install GitQ's Plugin:
2828
1. Download the repository on your local machine.
2929
2. Unzip the folder and extract it to a location of your choice on your PC.
3030
3. Now, open Google Chrome and Go to Settings
@@ -36,9 +36,10 @@ In the GitQ folder,
3636
9. GitQ Plugin gets installed on Chrome.
3737

3838
## Steps to use GitQ:
39-
1. Navigate to GitHub (https://github.com/)
40-
2. Navigate to any repository of your choice.
41-
3. You will see visual badges augumented to the repository page.
39+
1. Open the folder ```server```, and follow the instructions as stated in its Readme (https://github.com/gitq-for-github/plugin/blob/master/server/README.md)
40+
2. Navigate to GitHub (https://github.com/)
41+
3. Navigate to repository for which the metric-assessment is done via server.
42+
4. You will see visual badges augumented to the repository page.
4243

4344

4445
## How to contribute to GitQ

server/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
````
44
pip install -r requirements.txt
55
````
6-
> 2. Download ```gh```
6+
> 2. Install ```gh```
77
````
88
https://github.com/cli/cli#installation
99
````
@@ -41,7 +41,7 @@ chmod +x *sh
4141
chmod +x *sh
4242
./empty.sh
4343
(This also deletes the database file. Only retains the usable tool template)
44-
Follow the steps 4-9 again.
44+
Follow the steps 3-6 again.
4545
````
4646
> 10. To run a particular repository.
4747
````

0 commit comments

Comments
 (0)