Skip to content

Commit

Permalink
Update README and version for 3.2+ release
Browse files Browse the repository at this point in the history
  • Loading branch information
ctgraham committed Apr 30, 2021
1 parent 0145bed commit 77609c6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ This plugin provides display of PlumX Metrics from [Plum Analytics](http://pluma

## Requirements

* OJS 3.x
* for 2.x, see the [ojs-dev-2_4 branch](https://github.com/ulsdevteam/ojs-plum-plugin/tree/ojs-dev-2_4)
* OJS 3.2 or later
* Article level DOIs
* see: Login -> Settings -> Website -> Plugins -> DOI
* PlumX tracking of the artifacts with those DOIs
Expand All @@ -17,20 +16,26 @@ This plugin provides display of PlumX Metrics from [Plum Analytics](http://pluma

## Configuration

### Plugin Gallery installation

Install this as a "generic" plugin in OJS. The preferred installation method is through the Plugin Gallery.

### Manual installation

To install manually via the filesystem, extract the contents of this archive to a "plumAnalytics" directory under "plugins/generic" in your OJS root.

To install via Git submodule, target that same directory path:
```
git submodule add https://github.com/ulsdevteam/ojs-plum-plugin plugins/generic/plumAnalytics
```

If not installed via the Plugin Gallery, run the upgrade script to register this plugin, e.g.:
Installation via the Plugin Gallery will automatically register the plugin. If not installed via the Plugin Gallery, run the install or upgrade script to register the plugin, e.g.:
```
php lib/pkp/tools/installPluginVersion.php plugins/generic/plumAnalytics/version.xml
```

### Enable and Setup

Login as a Journal Manager and navigate to the Journal for which you wish to use the Widget. Enable the plugin via Login -> Settings -> Website -> Plugins -> Plum Analytics Artifact Widget -> Enable.

To configure the plugin, you will need to select what type of widget you want, and where it will display. Additional options may apply to specific widget types. See the [PlumX Widgets page](https://plu.mx/developers/widgets) for an overview of the different widget types and options.
Expand Down
2 changes: 1 addition & 1 deletion version.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<version>
<application>plumAnalytics</application>
<type>plugins.generic</type>
<release>1.3.0.2</release>
<release>1.4.0.0</release>
<date>2020-04-30</date>
<lazy-load>1</lazy-load>
<class>PlumAnalyticsPlugin</class>
Expand Down

0 comments on commit 77609c6

Please sign in to comment.