pkleindienst/octobercms-github-projects

v1.2.0 2017-05-21 10:25 UTC

This package is not auto-updated.

Last update: 2024-11-09 20:07:13 UTC


README

Software License Build Status HHVM StyleCI Quality Score Code Coverage

A plugin which utilizes to GitHub API to show informations about repositories.

Details

This plugin will provide a collection of components to display data about GitHub repositories based on the GitHub API v3.

As time passes more parts like Projects or Issues will be added to this collection of components.

Requirements

In order to work the PHP cURL extension must be installed and enabled.

Documentation

RepoList

List public repositories for the specified user.

Parameters

Item

Get a specific repository

The available variables which can be used in the component view are listed here: https://developer.github.com/v3/repos/#response-3

Parameters

Gist

Get a specific repository

The available variables which can be used in the component view are listed here: https://developer.github.com/v3/gists/#get-a-single-gist

Parameters

Contributing

Please submit pull requests with translations or bugfixes on the plugin's GitHub page. Bug reports and feature requests via Issues are welcome!

Security

If you discover any security related issues, please email security@pascalkleindienst.de instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.