Noi/BirthdayBot
1
0
Fork 0
mirror of https://github.com/NoiTheCat/BirthdayBot.git synced 2024-11-21 13:54:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update documentation site text

Browse source 
Similar format to World Time's page
This commit is contained in:
Noi 2023-01-24 19:18:41 -08:00
parent 20c84eb713
commit 088a465443
2 changed files with 20 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Docs/_config.yml
View file

@ -1,6 +1,6 @@
# https://github.com/BDHU/minimalist
title: Birthday Bot
description: A social time zone reference tool!
description: An automated way to recognize birthdays in your community!
logo: /birthday-cake.png
show_downloads: false
remote_theme: BDHU/minimalist

54
Docs/index.md
View file

@ -4,51 +4,35 @@ title: Documentation
---
# Birthday Bot
**Recognize birthdays in your Discord community!**
**An automated way to recognize birthdays in your community!**
Birthday Bot is a simple, single-purpose bot. It will set a role on your users for the duration of their birthdays and, if desired, can
announce a message in a channel of your choosing. Server owners can further specify a default time zone, with individual users also setting
their own to ensure everyone's birthdays are recognized precisely on time.
Birthday Bot is a utility for your community which enables your users to share their birthdays, check birthdays of others, and mark and announce birthdays as they happen. Server moderators can additionally set up a default time zone with users having the option to set their own, ensuring all birthdays are recognized precisely on time.
#### Getting started
This bot requires a small amount of initial set-up before it's ready for use. To quickly get started, ensure that you:
### Getting started
Invite the bot via the link on the sidebar. Please note that several permissions are requested during the invite process which are required for the bot to function properly.
Once added, a small amount of initial set-up before it's ready for use:
* Create a dedicated birthday role to be used only by the bot. Ensure the new role is placed beneath the bot's own role.
* **Do not use an existing role!** This bot assumes exclusive control over it. Users that have the role but are not having a birthday
*will* be removed from it!
* Instruct the bot to use the role: `/config role set-birthday-role`
At this point, you may also wish to do the following optional steps:
> <p style="font-style: normal"><svg xmlns="http://www.w3.org/2000/svg" style="vertical-align: -0.125em;" width="1em" height="1em" viewBox="0 0 16 16"><g fill="currentColor"><path d="M4.54.146A.5.5 0 0 1 4.893 0h6.214a.5.5 0 0 1 .353.146l4.394 4.394a.5.5 0 0 1 .146.353v6.214a.5.5 0 0 1-.146.353l-4.394 4.394a.5.5 0 0 1-.353.146H4.893a.5.5 0 0 1-.353-.146L.146 11.46A.5.5 0 0 1 0 11.107V4.893a.5.5 0 0 1 .146-.353L4.54.146zM5.1 1L1 5.1v5.8L5.1 15h5.8l4.1-4.1V5.1L10.9 1H5.1z"/><path d="M7.002 11a1 1 0 1 1 2 0a1 1 0 0 1-2 0zM7.1 4.995a.905.905 0 1 1 1.8 0l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 4.995z"/></g></svg> <strong>Do not use an existing role!</strong> This bot will take full and exclusive control over it. Users that have the role but are not having a birthday
*will* be removed from it!</p>
Optional, but recommended:
* Customize the announcement message: See `/config announce help` for more information.
* Set the birthday announcement channel: `/config announce set-channel`
* Set a default time zone: `/config set-timezone`
* Customize the announcement message: See `/config announce help` for more information.
#### Time zone support
You may specify a time zone in order to have your birthday recognized with respect to your local time. This bot only accepts zone names
from the IANA Time Zone Database (a.k.a. Olson Database).
* To find your zone: https://xske.github.io/tz/
* Interactive map: https://kevinnovak.github.io/Time-Zone-Picker/
* Complete list: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
### Supporting the bot
Birthday Bot is provided for free, period. No paywalled features, subscriptions, or monetization insentices. This is an independent hobby project done in my spare time, and all costs associated with it come out of my pocket. My only interest is to provide something that I hope others find as useful as I do.
#### Support the bot
Birthday Bot is and shall remain fully free to use. I have no plans to hide any new or existing features behind pay-only, premium features.
This is an independent hobby project and all costs associated with it come out of my pocket.
That said, this bot has proven to be far more popular than I ever anticipated, and keeping things running has occasionally strained me both financially and time-wise. If you'd like, please consider pitching in a bit to cover my recurring costs by checking out my Ko-fi page on the sidebar.
This bot has had a far greater response than I've ever expected, and at this point I find it difficult to pay for the server it runs on as
its resource needs grow. I would greatly appreciate if you consider pitching in a little bit to cover my recurring costs by checking out my
Ko-fi page: https://ko-fi.com/noithecat.
### Privacy and Security
This bot collects and stores only information necessary for its operation, then associated to user, server, and role IDs. As little information is stored as possible and access to the database is strongly restricted through proper security practices.
#### Support, Privacy and Security
The support server for my bots can be accessed via the given link: https://discord.gg/JCRyFk7. Further information in setting up the bot
can be found within it, as well as a small group of volunteers who are willing to answer questions.
Birthday information is not shared between servers *by design*, for those preferring to be selective about where they want their information known. Users must set their birthday settings in each individual server.
This bot collects and stores only information necessary for its operation, including user, server, and role IDs. This data is not stored
indefinitely, but is removed after an extended period of lack of use. If an individual member of a server is not seen after 360 days, their
data is purged. If the bot has been removed from a server, all data (including of its associated users) is purged after 180 days.
Any questions and concerns regarding data privacy, security, and retention may be sent to the bot author via the support server or by opening an issue on GitHub.
Birthdays are not shared between servers that this same bot may be in. This is *by design*, for those preferring to share their birthdays
with only certain communities instead of automatically sharing it to all of them. Users must enter their birthday information onto every
server they share with the bot for the servers they wish for it to be known in.
Any questions and concerns regarding data and security may be sent to the bot author via the support server or GitHub.
#### Image credit
### Image credit
<a href="https://www.flaticon.com/free-icons/cake" title="cake icons">Cake icons created by Freepik - Flaticon</a>