Merge pull request #3 from newls/enhancements/readme_md

collab. personal touch on the README.md
This commit is contained in:
Alexandre Delaunay 2016-06-23 16:36:22 +02:00 committed by GitHub
commit dfcbf84ede

View File

@ -1,8 +1,19 @@
# Example Plugin for GLPI # GLPi Example Plugin
## Introduction ## Introduction
This plugin aims to introduce how to interact with glpi HOOKS. This plugin implements a few basic glpi hooks.
Most of implemented features are for example and do nothing. Most of implemented features stands for example and are not
expected to provide fantastic functionality other than teaching.
See [documentation](https://github.com/pluginsGLPI/example/wiki) for plugin creation
## Documentation
This plugin is documented [here](https://github.com/pluginsGLPI/glpi-example-plugin/wiki),
It is the developer documentation for plugin contributors as of now.
## Installation
```sh
cd /my/glpi/deployment/main/directory/plugins
git clone git@github.com:pluginsGLPI/glpi-example-plugin.git example
```