From d96b07777e96e22d9c821e4b12c552760b2a69ae Mon Sep 17 00:00:00 2001 From: Alexander Minges Date: Thu, 10 Jul 2025 14:22:21 +0200 Subject: [PATCH] Move demo image from assets to docs directory --- README.md | 2 +- .../source/_static}/doi2dataset_demo.webp | Bin docs/source/usage.rst | 8 ++++++++ 3 files changed, 9 insertions(+), 1 deletion(-) rename {assets => docs/source/_static}/doi2dataset_demo.webp (100%) diff --git a/README.md b/README.md index df74609..187dbfe 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ **doi2dataset** is a Python tool designed to process DOIs and generate metadata for Dataverse.org datasets. It retrieves metadata from external APIs (such as OpenAlex and CrossRef), maps metadata fields, and can optionally upload the generated metadata to a Dataverse.org instance. -![doi2dataset Demo](assets/doi2dataset_demo.webp) +![doi2dataset Demo](docs/source/_static/doi2dataset_demo.webp) ## Features diff --git a/assets/doi2dataset_demo.webp b/docs/source/_static/doi2dataset_demo.webp similarity index 100% rename from assets/doi2dataset_demo.webp rename to docs/source/_static/doi2dataset_demo.webp diff --git a/docs/source/usage.rst b/docs/source/usage.rst index f287b00..11d3a08 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -3,6 +3,14 @@ Usage Running **doi2dataset** is done from the command line. Below is an example of how to use the tool. +Demo +---- +Here's a demonstration of **doi2dataset** in action: + +.. image:: _static/doi2dataset_demo.webp + :alt: doi2dataset demonstration + :align: center + Basic Example ------------- To process one or more DOIs, run: