Update docs

.zenodo.json

@@ -18,31 +18,52 @@
         "orcid": "0000-0002-0452-5571"
         }
     ],
-    "description": "A bash script to calculate the metrics of a remote GitHub repository",
+    "description": "An example pipeline that computes metrics of a repository",
     "access_right": "open",
     "license": "BSD-3-Clause",
     "prereserve_doi": true,
     "keywords": [
+        "bugzilla",
         "bus factor",
+        "bus factor",
+        "cloc",
+        "commits",
         "commits",
+        "delta lines of code",
         "engineering",
         "git",
+        "git",
+        "github",
         "github",
+        "gitlab",
+        "installable",
         "issue density",
+        "issue density",
+        "issue spoilage",
+        "issues",
         "issues",
         "kloc",
-        "loyola",
+        "lines of code",
+        "longitudinal graphs",
         "loyola university chicago",
+        "loyola",
         "luc",
-        "mining",
         "metrics",
-        "repository",
+        "metrics",
+        "mining",
+        "productivity",
+        "python",
         "repository mining",
+        "repository",
         "simple",
-        "software",
+        "sloccount",
         "software engineering",
         "software metrics",
         "software systems laboratory",
-        "ssl"
+        "software",
+        "ssl",
+        "thousands of lines of code",
+        "tool",
+        "vcs"
     ]
 }

CITATION.cff

@@ -16,9 +16,9 @@ authors:
   email: nsynovic@luc.edu
   affiliation: Loyola University Chicago
   orcid: 'https://orcid.org/0000-0003-0413-4594'
-  
-title: "SoftwareSystemsLaboratory/ssl-metrics-pipeline"
-version: 0.1.4
-doi: 10.5281/zenodo.5999411
+
+title: "SoftwareSystemsLaboratory/clime-pipeline"
+version: 0.2
+doi:
 date-released: 2022-02-07
-url: "https://github.com/SoftwareSystemsLaboratory/ssl-metrics-pipeline"
+url: "https://github.com/SoftwareSystemsLaboratory/clime-pipeline"

README.md

@@ -1,17 +1,13 @@
-# Software Systems Laboratory Metrics Pipeline
+# CLIME Pipeline
 
-> A `bash` script to calculate the metrics of a remote GitHub repository
-
-![[https://img.shields.io/badge/shell-bash-blue](https://img.shields.io/badge/shell-bash-blue)](https://img.shields.io/badge/shell-bash-blue)
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5967365.svg)](https://doi.org/10.5281/zenodo.5967365)
-[![Release Project](https://github.com/SoftwareSystemsLaboratory/ssl-metrics-pipeline/actions/workflows/release.yml/badge.svg)](https://github.com/SoftwareSystemsLaboratory/ssl-metrics-pipeline/actions/workflows/release.yml)
-![[https://img.shields.io/badge/license-BSD--3-yellow](https://img.shields.io/badge/license-BSD--3-yellow)](https://img.shields.io/badge/license-BSD--3-yellow)
+> An example pipeline that computes metrics of a repository
 
 ## Table of Contents
 
-- [Software Systems Laboratory Metrics Pipeline](#software-systems-laboratory-metrics-pipeline)
+- [CLIME Pipeline](#clime-pipeline)
   - [Table of Contents](#table-of-contents)
   - [About](#about)
+    - [Licensing](#licensing)
   - [Tooling](#tooling)
     - [Operating System](#operating-system)
     - [Shell Software](#shell-software)
@@ -24,10 +20,12 @@
 
 ## About
 
-The Software Systems Laboratory (SSL) Pipeline Project is a `bash` script that can be executed within a *configured* environment to calculate metrics for a (or multiple) **remote** repositories hosted on GitHub.
+The Software Systems Laboratory (SSL) CLIME Pipeline Project is an example pipeline that computes metrics of a repository.
 
 The pipeline *only* calculates metrics for the `HEAD` branch of a repository.
 
+### Licensing
+
 This project is licensed under the BSD-3-Clause. See the [LICENSE](LICENSE) for more information.
 
 ## Tooling
@@ -55,11 +53,11 @@ It is recomendded to run on Mac OS or Linux. However, if you are on a Windows ma
 
 All listed Python software assumes that you have downloaded and installed **Python 3.10** or greater.
 
-- `ssl-metrics-meta`
+- `clime-metrics`
 
 You can install the Python software with this one-liner:
 
-`pip install --upgrade pip ssl-metrics-meta` or `./setup.bash`
+`pip install --upgrade pip clime-metrics` or `./setup.bash`
 
 ## How To Use