From 0da100c4310fe379dddae71dad0efe3f5887cfe8 Mon Sep 17 00:00:00 2001
From: Ioannis Igoumenos <ioigoume@gmail.com>
Date: Tue, 20 Feb 2024 09:33:58 +0000
Subject: [PATCH] add the READMD.md file

---
 Lib/GrouperApiAccess.php |  4 ++--
 README.md                | 22 ++++++++++------------
 2 files changed, 12 insertions(+), 14 deletions(-)

diff --git a/Lib/GrouperApiAccess.php b/Lib/GrouperApiAccess.php
index 8c96f2f..cf3342e 100644
--- a/Lib/GrouperApiAccess.php
+++ b/Lib/GrouperApiAccess.php
@@ -81,7 +81,7 @@ public function __construct(array $cfg)
    * @return string Requests success or not
    * @throws GrouperLiteWidgetException|JsonException
    */
-  public function addGrouperGroupMember(array $queryData)
+  public function addGrouperGroupMember(array $queryData): string
   {
     $groupName = $queryData['groupName'];
     $actionEndpoint = "/groups/$groupName/members";
@@ -119,7 +119,7 @@ public function addGrouperGroupMember(array $queryData)
    * @throws GrouperLiteWidgetException
    *
    */
-  public function createGroupWithTemplate(array $queryData)
+  public function createGroupWithTemplate(array $queryData): array
   {
     //Currently, only supporting create group, need to test if update a group will work!
 
diff --git a/README.md b/README.md
index 80d5219..11242ca 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,14 @@
-# coManage Grouper
+# COmanage Grouper Lite Widget Plugin
 
 ## Instructions:
-### To use in coMananage:
-* With your favorite command line tool, navigate to a directory you wish to use to house the coManage plugin.
-* Copy the source files from the GrouperLite Plugin located at [https://github.internet2.edu/internet2/comanage-grouper-widget](https://github.internet2.edu/internet2/comanage-grouper-widget)
+### To use in COManage:
+* With your favorite command line tool, navigate to a directory you wish to use to house the COmanage plugin.
+* Copy the source files from the GrouperLiteWidget Plugin located at [https://github.internet2.edu/internet2/comanage-grouper-widget](https://github.internet2.edu/internet2/comanage-grouper-widget)
 * You can either download the source files as a ZipFile or Clone the directory from GitHub repository.
-  * ZipFile: unzip into a new ```GrouperLite/``` directory.
-  * Clone: ```git clone https://github.internet2.edu/internet2/comanage-grouper-widget GrouperLite/```
+    * ZipFile: unzip into a new `GrouperLiteWidget/` directory.
+    * Clone: `git clone https://github.internet2.edu/internet2/comanage-grouper-widget GrouperLiteWidget/`
 * Copy the application location for symlinking below.
-* Navigate to your coManage source directory.
-* From the root of your coManage installation, go to the ```local/Plugin/``` directory.
-* Symlink your GrouperLite location under the Plugin directory.
-  * ```ln -s <location-of-Plugin>/GrouperLite <location-of-coManage>/local/Plugin/GrouperLite```
-    
-
+* Navigate to your COmanage source directory.
+* From the root of your COmanage installation, go to the `local/Plugin/` directory.
+* Symlink your GrouperLiteWidget location under the Plugin directory.
+    * `ln -s <location-of-Plugin>/GrouperLiteWidget <location-of-COmanage>/local/Plugin/GrouperLiteWidget`