From f57c2f59b20f2a2109aa3e641f6c9361ea1289b7 Mon Sep 17 00:00:00 2001 From: Nelson Zamith Date: Thu, 23 Jun 2016 15:20:15 +0200 Subject: [PATCH 1/3] collab. personal touch on the README.md --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b64e8f6..6e8306e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,14 @@ -# 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. + +## Installation + +```sh +cd /my/glpi/deployment/main/directory/plugins +git clone git@github.com:pluginsGLPI/glpi-example-plugin.git example +``` \ No newline at end of file From c61e0b6546563cd801d987e04961758aeff57b32 Mon Sep 17 00:00:00 2001 From: Nelson Zamith Date: Thu, 23 Jun 2016 16:08:28 +0200 Subject: [PATCH 2/3] complete personal touch. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6e8306e..9cc2dc5 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ This plugin implements a few basic glpi hooks. Most of implemented features stands for example and are not -expected to provide fantastic functionality. +expected to provide fantastic functionality other than teaching. ## Installation ```sh cd /my/glpi/deployment/main/directory/plugins git clone git@github.com:pluginsGLPI/glpi-example-plugin.git example -``` \ No newline at end of file +``` From 7477e1bd0252fbedef3878a9246ace5a7daac050 Mon Sep 17 00:00:00 2001 From: Nelson Zamith Date: Thu, 23 Jun 2016 16:32:51 +0200 Subject: [PATCH 3/3] remembering developer documentation --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 9cc2dc5..3d221fb 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,11 @@ 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