Skip to content

Commit

Permalink
add the READMD.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
Ioannis committed Feb 20, 2024
1 parent 67f0b3a commit 11dc0d3
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
4 changes: 2 additions & 2 deletions Lib/GrouperApiAccess.php
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down Expand Up @@ -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!

Expand Down
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# COmanage Grouper Lite Widget Plugin

## Instructions:
### 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 `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 GrouperLiteWidget location under the Plugin directory.
* `ln -s <location-of-Plugin>/GrouperLiteWidget <location-of-COmanage>/local/Plugin/GrouperLiteWidget`


0 comments on commit 11dc0d3

Please sign in to comment.