From da89481a2f16f149334643735237dc0211ac55a1 Mon Sep 17 00:00:00 2001 From: halcy Date: Sun, 11 Feb 2024 22:53:49 +0200 Subject: [PATCH] add research note to docs --- CHANGELOG.rst | 1 + docs/index.rst | 10 ++++++++++ 2 files changed, 11 insertions(+) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index ab334df..e592461 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -13,6 +13,7 @@ v2.0.0 (IN PROGRESS) * Added `offset` parameter to `trending_statuses` (Thanks @Teqed) * We're now using space age technology (pyproject.toml - thanks @codl) * Add py.typed marker (Thanks @ZeeD for the suggestion) +* Added CITATION.cff (Thanks @hauschke for the suggestion) v1.8.1 ------ diff --git a/docs/index.rst b/docs/index.rst index b4e4758..682686e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -70,6 +70,16 @@ about who helped with which particular feature or fix in the changelog. .. _The mastodon project as such: https://joinmastodon.org/ .. _Official Mastodon API docs: https://docs.joinmastodon.org/api/guidelines/ +Research use and citing +----------------------- +If you use Mastodon.py in your research, please cite it according to the latest CITATION.cff from the repository: + +https://github.com/halcy/Mastodon.py/blob/master/CITATION.cff + +As a personal request, It is important to me to ask you to make sure that the subjects of +your research - fediverse users - are alright with the research you are doing on them +and/or that you have secured the approval of your institutions ethics board. + .. toctree:: :caption: Introduction