Skip to content

Commit 4001b0c

Browse files
authored
Update README.rst improve readability
1 parent 71bfebc commit 4001b0c

File tree

1 file changed

+28
-11
lines changed

1 file changed

+28
-11
lines changed

README.rst

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,35 @@ MAP Plugin Database
44

55
.. _MAP Client: https://github.com/MusculoskeletalAtlasProject/mapclient
66
.. _MAP Plugin Database: https://github.com/MusculoskeletalAtlasProject/map-plugin-database
7+
.. _MAP Plugin Database New Issue: https://github.com/MusculoskeletalAtlasProject/map-plugin-database/issues/new
78

8-
The `MAP Client`_ is a cross-platform, plugin-based framework for managing workflows. Since the Plugin lies at the heart of the MAP
9-
framework, the ability to easily find and share MAP plugins is an important aspect of the MAP-Client's usability.
9+
Overview
10+
--------
1011

11-
The `MAP Plugin Database`_ contains basic information about all of the known, published MAP-Client plugins. The primary use of this
12-
database is to allow users of the MAP-Client to search for and install MAP-Client plugins directly from within the MAP-Client itself,
13-
rather than having to install plugins manually. Specifically, the *Plugin Finder* tool can be found in the MAP-Client application under
14-
the *Tools* menu dropdown.
12+
The `MAP Client`_ is a cross-platform, plugin-based framework for managing scientific workflows. Since plugins are central to the MAP Client's functionality, having a streamlined way to discover and share them is essential for usability.
1513

16-
MAP-Client users are able to submit their own MAP plugins to the MAP Plugin Database. Currently the recommended process for doing this is
17-
to submit an issue in the `MAP Plugin Database`_ GitHub repository. The issue should be tagged with the *add-plugin* label. The body of the
18-
issue submission should contain only the GitHub repository path of the plugin to be added; this path should be in the format:
19-
*{organization}/{repository}*, for example: *mapclient-plugins/pointsourcestep*.
14+
The `MAP Plugin Database`_ is a centralised repository containing metadata about all known, published MAP Client plugins. Its primary purpose is to enable users to search for and install plugins directly from within the MAP Client, eliminating manual installation.
15+
16+
Accessing Plugins
17+
-----------------
18+
19+
Users can access the *Plugin Finder* tool within the MAP Client application via the *Tools* menu. This tool allows users to browse and install available plugins from the database.
20+
21+
Submitting a Plugin
22+
-------------------
23+
24+
MAP Client users are encouraged to contribute their plugins to the database. The recommended submission process is as follows:
25+
26+
1. Navigate to the `MAP Plugin Database New Issue`_ page.
27+
2. Create a new issue and add the :code:`add-plugin` label.
28+
3. In the issue body, include only the GitHub repository path of the plugin in the format::
29+
30+
{organization}/{repository}
31+
32+
Example: :code:`mapclient-plugins/pointsourcestep`
33+
34+
Maintaining the Database
35+
------------------------
36+
37+
Editing database entries and triggering automated updates are **restricted** to repository maintainers.
2038

21-
Editing database entries and triggering the automated processes to update this database are restricted to repository maintainers.

0 commit comments

Comments
 (0)