Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add notes about forthcoming release
  • Loading branch information
jesusbagpuss authored Aug 12, 2022
1 parent 0e4f130 commit 518d144
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,22 @@ There are some configuration options available, these are detailed in the z_altm
Originally developed by Sébastien François (https://github.com/sebastfr); updated by @drtjmb.
Now maintained by *us* - eprintsug!

**Version 1.2.0**: Adds the repository domain to the link back to Altmetric. This can enable more data to be shown.
See note in z_altmatric.pl for details on how to register your repository domain.
## Version history ##

**Version 1.1.0**: Adds ability to use other IDs supported by Altmetric API e.g. ISBN.
### Version 1.3.0 (not released yet) ###
- Adds user-agent in request made to Altmetric API
- Displays default phrase (supports multiple languages) with link to Altmetric site before badge is displayed. See the [altmetric.xml phrase file](lib/lang/en/phrases/altmetric.xml#L9).
- Above phrase is also used when the badge is displayed
- If there is no Altmetric-supported identifier in the record, the EPrints Box is not rendered

If you add internationalised phrases to your repository and they don't appear to work, make sure the 'auto' javascript file has been reloaded.

### Version 1.2.0 ###
Adds the repository domain to the link back to Altmetric. This can enable more data to be shown.
See note in z_altmetric.pl for details on how to register your repository domain.

### Version 1.1.0 ###
Adds ability to use other IDs supported by Altmetric API e.g. ISBN.
The data used from the EPrint is now a config option so repositories can tailor this to suit the data they hold. See cfg.d/z_altmetric.pl.

The attributes used for the rendering have changed to:
Expand All @@ -23,3 +35,8 @@ The attributes used for the rendering have changed to:

If you are integrating the Altmetrics using something other than the `EPrints::Plugin::Screen::EPrint::Box::Altmetric` class,
you will need to change how you render the attributes yourself!

## Displaying Altmetric data without using this plugin ##

The Altmetric team also provide a wrapper script that can be used to add Altmetric badges to your pages. Details are provided
on their support site: https://help.altmetric.com/support/solutions/articles/6000241753-adding-badges-in-eprints

0 comments on commit 518d144

Please sign in to comment.