add CITATION

diff --git a/CITATION.cff b/CITATION.cff
new file mode 100644 (file)
index 0000000..1052734
--- /dev/null
+++ b/CITATION.cff
@@ -0,0 +1,42 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: Wayback Tweets
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: Clarissa
+    family-names: Mendes
+    email: support@claromes.com
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.12528448
+    description: The concept DOI of the work.
+  - type: url
+    value: "https://pypi.org/project/waybacktweets/"
+    description: Python Package Index.
+  - type: url
+    value: "https://claromes.github.io/waybacktweets/"
+    description: Documentation.
+repository-code: "https://github.com/claromes/waybacktweets"
+url: "https://claromes.github.io/waybacktweets"
+abstract: >-
+  Retrieves archived tweets CDX data from the Wayback
+  Machine, performs necessary parsing, and saves the data in
+  HTML (for easy viewing of the tweets using the iframe
+  tag), CSV, and JSON formats.
+keywords:
+  - Twitter
+  - Wayback Machine
+  - Tweets
+  - Python
+  - OSINT
+  - SOCMINT
+  - X
+license: GPL-3.0
+commit: 16f9997a8e2e2b87932ca061bf5731cd65d1d588
+version: 1.0a5
+date-released: "2024-06-24"

diff --git a/README.md b/README.md
index 47d55da6095725778b8ecc3d3b1ee4dd21836012..2bd1b232e3e0d6db2d49e5c63a0fbed81b03b047 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Wayback Tweets
 
-[![PyPI](https://img.shields.io/pypi/v/waybacktweets)](https://pypi.org/project/waybacktweets) [![docs](https://github.com/claromes/waybacktweets/actions/workflows/docs.yml/badge.svg)](https://github.com/claromes/waybacktweets/actions/workflows/docs.yml) [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://waybacktweets.streamlit.app)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.12528448.svg)](https://doi.org/10.5281/zenodo.12528448) [![PyPI](https://img.shields.io/pypi/v/waybacktweets)](https://pypi.org/project/waybacktweets) [![docs](https://github.com/claromes/waybacktweets/actions/workflows/docs.yml/badge.svg)](https://github.com/claromes/waybacktweets/actions/workflows/docs.yml) [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://waybacktweets.streamlit.app)
 
 Retrieves archived tweets CDX data from the Wayback Machine, performs necessary parsing (see [Field Options](https://claromes.github.io/waybacktweets/field_options.html)), and saves the data in HTML (for easy viewing of the tweets using the `iframe` tag), CSV, and JSON formats.
 

diff --git a/docs/index.rst b/docs/index.rst
index 99dfe60a668ecf49d3421833a1ae087ffcdfd3b7..f6a5578aeddac9d23c93656998f35f80fdf28edb 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -11,6 +11,9 @@ Pre-release: |release|
 
 Retrieves archived tweets CDX data from the Wayback Machine, performs necessary parsing (see :ref:`field_options`), and saves the data in HTML (for easy viewing of the tweets using the ``iframe`` tag), CSV, and JSON formats.
 
+.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.12528448.svg
+  :target: https://doi.org/10.5281/zenodo.12528448
+
 .. note::
     Intensive queries can lead to rate limiting, resulting in a temporary ban of a few minutes from web.archive.org.