Skip to content

Commit a489aed

Browse files
committed
Added documentation for group-blacklisting.
1 parent 614a36e commit a489aed

1 file changed

Lines changed: 20 additions & 1 deletion

File tree

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ missing notifications on Google Calendar Birthday Calendar.
2121
- [Installation and setup](#installation-and-setup)
2222
- [Additional information](#additional-information)
2323
- [Stopping/uninstalling/deleting the script](#stoppinguninstallingdeleting-the-script)
24+
- [Blacklisting](#blacklisting)
25+
- [Group blacklisting](#group-blacklisting)
26+
- [Blacklisting specific events for specific contacts](#blacklisting-specific-events-for-specific-contacts)
2427
- [Translation](#translation)
2528
- [Bug and error reporting, help requests](#bug-and-error-reporting-help-requests)
2629
- [Unresponsive help requests](#unresponsive-help-requests)
@@ -63,7 +66,23 @@ steps:
6366
If you want to be extra sure you can wait some days to confirm that no email is
6467
sent to you anymore and only then delete the script file: this is up to you.
6568

66-
### Blacklisting specific events for specific contacts
69+
### Blacklisting
70+
71+
#### Group blacklisting
72+
73+
You can set the `settings.notifications.blacklistedGroups` variable to a list of
74+
contact groups you do not want to receive event notifications for.
75+
This can be used in two ways:
76+
77+
- if the contacts you do not want to receive the notifications for are already
78+
in a group (e.g. you might have an 'Extended family' group containing the
79+
contacts of far relatives whose birthdays you are not actually interested in)
80+
you can add that group name to the `blacklistedGroups` list
81+
- if you have a certain number of contacts that you want to blacklist, but they
82+
do not share a common group you can add them to a new group (e.g:
83+
'GCEN-blacklist') and add that group name to the `blacklistedGroups` list
84+
85+
#### Blacklisting specific events for specific contacts
6786

6887
There are three event-types for which notifications can be statically
6988
enabled/disabled for by editing the `settings.notifications.eventTypes`

0 commit comments

Comments
 (0)