Update readmes and citation

UWCSESecurityLab · Jul 31, 2024 · c2997e8 · c2997e8
1 parent 7673455
commit c2997e8
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -2,7 +2,7 @@
 # Visit https://bit.ly/cffinit to generate yours today!
 
 cff-version: 1.2.0
-title: adscraper
+title: "adscraper: A Web Crawler for Measuring Online Ad Content"
 message: >-
   If you used adscraper in your research, please cite this
   repository!

diff --git a/README.md b/README.md
@@ -60,7 +60,12 @@ If you used adscraper in your research project, please cite the repository
 using the following BibTeX:
 
 ```bibtex
-TODO
+@software{Eric_Zeng_adscraper,
+author = {Eric Zeng},
+license = {MIT},
+title = {{adscraper: A Web Crawler for Measuring Online Ad Content}},
+url = {https://github.com/UWCSESecurityLab/adscraper}
+}
 ```
 
 ## Setup

diff --git a/crawl-cluster/README.md b/crawl-cluster/README.md
@@ -159,7 +159,7 @@ and the crawl lists that should be used.
 [src/jobSpec.ts](src/jobSpec.ts) contains a TypeScript interface for the
 job specification file.
 
-TODO: describe schemas
+TODO: describe schemas and configuration options, provide examples
 
 ### Running crawl jobs
 
@@ -224,7 +224,6 @@ the pod and let Kubernetes restart the crawl:
 kubectl delete pod <pod-name>
 ```
 
-
 ### Viewing crawl results
 
 Outputs will be stored in the Postgres database and in the storage volume