Merge pull request #4 from hexrom/develop

Develop

.github/workflows/main.yml

@@ -0,0 +1,31 @@
+name: Python App Workflow
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.8'
+
+    - name: Install dependencies
+      run: |
+        python3 -m pip install --upgrade pip
+        pip3 install -r requirements.txt
+
+    - name: Run GitMiner
+      run: |
+        cp config.json.example config.json
+        python3 gitminer.py  --help

README.md

@@ -1,4 +1,4 @@
-<img src="img/ghe-miner.png" alt="Logo" width="900" height="255">
+<img src="img/gitminer.png" width="640" height="320" alt="Logo">
 
 # GHE Miner
 GitMiner will query Github useful source code data at the Enterprise, Organization or Repository level.
@@ -50,20 +50,19 @@ Get a single repo from an org:
 Local run:
 
 ```
-$ python gitminer.py --hostname acme --org DevOps --repo GitMiner
+$ python3 gitminer.py --hostname acme --org DevOps --repo ghe-miner
 ```
 
-
 Get all repos for a single org:
 
 ```
-$ python gitminer.py --hostname acme --org DevOps
+$ python3 gitminer.py --hostname acme --org DevOps
 ```
 
 Get all repos for all orgs:
 
 ```
-$ python gitminer.py --hostname acme --all
+$ python3 gitminer.py --hostname acme --all
 ```
 
 # Sample Output