diff --git a/README.md b/README.md index b64e8f6..3d221fb 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,19 @@ -# Example Plugin for GLPI +# GLPi Example Plugin ## Introduction -This plugin aims to introduce how to interact with glpi HOOKS. -Most of implemented features are for example and do nothing. - -See [documentation](https://github.com/pluginsGLPI/example/wiki) for plugin creation +This plugin implements a few basic glpi hooks. +Most of implemented features stands for example and are not +expected to provide fantastic functionality other than teaching. + +## 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 +```