https://github.com/YOURLS/plugin-sample

📒 Repository template for a YOURLS plugin
https://github.com/YOURLS/plugin-sample

php plugin template yourls yourls-plugin

Last synced: 14 days ago
JSON representation

📒 Repository template for a YOURLS plugin

• Host: GitHub
• URL: https://github.com/YOURLS/plugin-sample
• Owner: YOURLS
• License: mit
• Created: 2013-04-08T17:33:39.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2022-04-23T09:36:35.000Z (over 2 years ago)
• Last Synced: 2024-10-24T00:12:57.348Z (24 days ago)
• Topics: php, plugin, template, yourls, yourls-plugin
• Language: PHP
• Homepage: https://github.com/YOURLS/plugin-sample/generate
• Size: 11.7 KB
• Stars: 21
• Watchers: 11
• Forks: 57
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - Sample YOURLS plugin template

README

        
# [Plugin Name] [![Listed in Awesome YOURLS!](https://img.shields.io/badge/Awesome-YOURLS-C5A3BE)](https://github.com/YOURLS/awesome-yourls/)

:bulb: Plugin short description: what it does

Requires [YOURLS](https://yourls.org) `` and above.

## Usage

:bulb: This is a great place for showing a few usage examples!

:camera: If applicable, a screenshot of the admin interface or anything relevant is super helpful

## Installation

:bulb: This is a great place for showing how to install the package. The common way is as below:

1. In `/user/plugins`, create a new folder named ``.

2. Drop these files in that directory.

3. Go to the Plugins administration page (eg. `http://sho.rt/admin/plugins.php`) and activate the plugin.

4. Have fun!

## License

:bulb: The license might be updated with your terms.

This package is licensed under the [MIT License](LICENSE).