From ca9cc810706728bfb48d1c7e60ee41b4ba3055c5 Mon Sep 17 00:00:00 2001
From: Taylor Salo <salot@pennmedicine.upenn.edu>
Date: Wed, 28 Aug 2024 13:46:09 -0400
Subject: [PATCH] Update installation documentation (#47)

* Update installation instructions.

* Create config.yml

* Update installation.rst
---
 .github/ISSUE_TEMPLATE/config.yml |  5 +++++
 README.md                         |  8 +++-----
 docs/installation.rst             | 21 ++-------------------
 3 files changed, 10 insertions(+), 24 deletions(-)
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..f2219cf
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Questions
+    url: https://neurostars.org/tag/fmripost-aroma
+    about: For general questions, please search Neurostars for existing posts before starting a new one.
diff --git a/README.md b/README.md
index a05dbc2..ef4eb9c 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
 # fmripost-aroma
 
+[![Docker Image](https://img.shields.io/badge/docker-nipreps/fmripost--aroma-brightgreen.svg?logo=docker&style=flat)](https://hub.docker.com/r/nipreps/fmripost-aroma/tags/)
 [![PyPI - Version](https://img.shields.io/pypi/v/fmripost-aroma.svg)](https://pypi.org/project/fmripost-aroma)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fmripost-aroma.svg)](https://pypi.org/project/fmripost-aroma)
 
@@ -7,10 +8,7 @@ fMRIPost-AROMA is a BIDS App for running ICA-AROMA on a preprocessed
 fMRI dataset.
 It is intended to replace the built-in workflow in fMRIPrep 23.0 and earlier,
 but accepts any BIDS derivatives dataset where BOLD images have been resampled
-to MNI152NLin6Asym.
-
-***This is currently a placeholder. The workflow still needs to be copied here
-and packaged.***
+to MNI152NLin6Asym at 2 mm3 resolution.
 
 -----
 
@@ -22,7 +20,7 @@ and packaged.***
 ## Installation
 
 ```console
-pip install fmripost-aroma
+docker pull nipreps/fmripost-aroma:unstable
 ```
 
 ## License
diff --git a/docs/installation.rst b/docs/installation.rst
index 30556fd..34aab69 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -5,26 +5,9 @@ Installation
 ------------
 *fMRIPost-AROMA* should be installed using container technologies.
 
-The ``fmripost-aroma`` command-line adheres to the `BIDS-Apps recommendations
-for the user interface <usage.html#execution-and-the-bids-format>`__.
-Therefore, the command-line has the following structure::
+.. code-block:: bash
+  docker pull nipreps/fmripost-aroma:unstable
 
-  $ fmripost-aroma <input_bids_path> -d <derivatives_path> <analysis_level> <named_options>
-
-The ``fmripost-aroma`` command-line options are documented in the :ref:`usage`
-section.
-
-The command-line will be composed of a preamble to configure the
-container execution followed by the ``fmripost-aroma`` command-line options
-as if you were running it on a *bare-metal* installation.
-The command-line structure above is then modified as follows::
-
-  $ <container_command_and_options> <container_image> \
-       <input_bids_path> <derivatives_path> <analysis_level> <fmriprep_named_options>
-
-Therefore, once specified the container options and the image to be run
-the command line is the same as for the *bare-metal* installation but dropping
-the ``fmripost-aroma`` executable name.
 
 Containerized execution (Docker and Singularity)
 ================================================