webbuilders-group/silverstripe-packagistshortcode

Add a short code for adding a Packagist installs button with a count to a HTMLText field.

0.1 2013-12-18 15:01 UTC

README

Add a short code for adding a Packagist installs button with a count to a HTMLText field.

Maintainer Contact

Requirements

  • SilverStripe CMS 3.x

Installation

Usage

Usage is pretty straight forward to add a packagist downloads button you simply add the following:

[packagist package="package owner/package name"]

Optionally you may add mode="monthly" or button="daily" (defaults to total) to show the download count for the given period.

[packagist package="package owner/package name" mode="monthly"]

In 3.1 the short codes above will work as included however the updated syntax for the short code would be (of course layout and button are not required):

[packagist,package="package owner/package name",mode="monthly"]
Configuration Options

There are a few configuration options available to you:

PackagistShortCode:
    CacheTime: 86400 #Cache time in seconds (default is 1 day, remember the GitHub api is rate limited)
    UseShortHandNumbers: true #Use short hand numbers i.e 5.6K or not