Documentation update

Author: oree-xx

README.md

@@ -1,30 +1,72 @@
-# quantifying
+# Quantifying
 
-Quantifying the Commons
+Quantifying the Commons - Measuring the diversity of Openly Licensed and Public Domain Works
 
 
 ## Overview
 
-This project seeks to quantify the size and diversity of the commons--the
-collection of works that are openly licensed or in the public domain.
+This project seeks to quantify the size and diversity of the creative commons legal tools. We aim to track the collection of works (articles, images, publications) that are openly licensed or in the public domain. The project automates data collection from multiple data sources, processes the data, and generates reports.
 
 
-### Meaningful
+#### The three phases of generating a report:
 
-The reports generated by this project (and the data fetched and processed to
-support it) seeks to be meaningful. We hope this project will provide data and
-analysis that helps inform discussions about the commons--the collection of
-works that are openly licensed or in the public domain.
+- 1-Fetch - This phase involves collecting data from a specific source using its API. Before writing any code, we plan the analyses we want to perform by asking meaningful questions about the data. We also consider API limitations (such as query limits) and design a query strategy to work within those constraints.
 
-The goal of this project is to help answer questions like:
-- How has the world's use of the commons changed over time?
-- How is the knowledge and culture of the commons distributed?
-  - Who has access (and how much) to the commons?
-- What significant trends can be observed in the commons?
-  - Which public domain dedication or licenses are the most popular?
-  - What are the correlations between public domain dedication or licenses and
-    region, language, domain/endeavor, etc.?
 
+   - Meaningful questions:
+     The reports generated by this project (and the data fetched and processed to support it) seeks to be meaningful. We hope this project will provide data and analysis that helps inform discussions about the commons--the collection of works that are openly licensed or in the public domain.
+     The goal of this project is to help answer questions like:
+     - How has the world's use of the commons changed over time?
+       - How is the knowledge and culture of the commons distributed?
+     - Who has access (and how much) to the commons?
+       - What significant trends can be observed in the commons?
+     - Which public domain dedication or licenses are the most popular?
+       - What are the correlations between public domain dedication or licenses and
+         region, language, domain/endeavor, etc.?
+
+
+   - Limitations of an API
+      - Some data sources provide APIs with certain limitations. A common limitation is a daily or hourly query limit, which restricts how many requests can be made in a given time period. To work around this, we carefully plan our queries, batch requests where possible, and schedule fetch jobs to stay within the allowed limits.
+   - Headings of data in 1-fetch
+      - [Tool identifier](https://creativecommons.org/share-your-work/cclicenses/): A unique identifier used to distinguish each Creative Commons legal tool within the dataset. This helps ensure consistency when tracking tools across different data sources.
+      - [SPDX identifier](https://spdx.org/licenses/): A standardized identifier maintained by the Software Package Data Exchange (SPDX) project. It provides a consistent way to reference licenses and improves interoperability across systems.
+
+
+- 2-Process: In this phase, the fetched data is transformed into a structured and standardized format for analysis. The data is then analyzed and categorized based on defined criteria to extract insights that answer the meaningful questions identified during the fetch stage.
+
+
+- 3-report: This phase focuses on presenting the results of the analysis. We generate graphs and summaries that clearly show trends, patterns, and distributions in the data. These reports help communicate key insights about the size, diversity, and characteristics of openly licensed and public-domain works.
+
+
+#### Automation scripts
+For automating these steps, the project uses Python scripts to fetch, process, and report data. GitHub Actions is used to automatically run these scripts on a defined schedule and on code updates. It handles task execution, manages dependencies, and ensures the workflow runs consistently.
+
+
+- Script assumptions
+  - Execution schedule for each quarter:
+    - 1-Fetch: first month, 1st half of second month
+    - 2-Process: 2nd half of second month
+    - 3-Report: third month
+
+- Script requirements
+   - Must be safe
+      - Scripts must not make any changes with default options
+      - Easiest way to run script should also be the safest
+      - Have options spelled out
+      - Must be timely
+   - Scripts should complete within a maximum of 45 minutes
+      - Scripts shouldn't take longer than 3 minutes with default options
+      - That way there’s a quicker way to see what is happening when it is running; see execution, without errors, etc.
+      - Then later in production it can be run with longer options
+   - Must be idempotent (Idempotence - [Wikipedia](https://en.wikipedia.org/wiki/Idempotence))
+      - This applies to both the data fetched and the data stored.
+        If the data changes randomly, we can't draw meaningful conclusions
+   - Balanced use of third-party libraries
+      - Third-party libraries should be leveraged when they are:
+           - API specific (google-api-python-client, internetarchive, etc.)
+   - File formats
+      - CSV - the format is well supported (rendered on GitHub, etc.), easy to use, and the data used by the project is simple enough to avoid any shortcomings.
+   - YAML - prioritizes human readability which addresses the primary costs and risks associated with configuration files.
 
 ## Code of conduct
 
@@ -93,7 +135,6 @@ Quantifying/
 
 ## Development
 
-
 ### Prerequisites
 
 For information on learning and installing the prerequisite technologies for