Skip to content

Commit

Permalink
Improve documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
miqrogroove committed Oct 14, 2020
1 parent 4e192f2 commit b8acdc4
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,14 @@ After installing this module, the "tree page" becomes the new "home page". The
1. Go test out your front page (root path) as well as the login page.

## To Disable
The preferred way to switch off the module is to rename `modules_v4/family-tree-home/` to `modules_v4/family-tree-home.disable/`
1. Visit the Control Panel
1. Click "All modules"
1. Scroll to "Family Tree Home Page"
1. Clear the checkbox for this module.
1. Scroll to the bottom.
1. Click the "save" button.

Alternatively, you can unload the module by renaming `modules_v4/family-tree-home/` to `modules_v4/family-tree-home.disable/`

## To Uninstall
It is safe to delete the `family-tree-home` directory at any time.
2 changes: 1 addition & 1 deletion module.php
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ public function title(): string
*/
public function description(): string
{
return 'This module changes the front page for signed-in users. After a sign in from the front page, users will go back to the Family Tree instead of redirecting My Page.';
return 'This module changes the front page for signed-in users. After a sign in from the front page, users will go back to the Family Tree instead of redirecting to My Page.';
}

/**
Expand Down

0 comments on commit b8acdc4

Please sign in to comment.