Skip to content

Commit

Permalink
Docs & Readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
littleironical committed Apr 10, 2021
1 parent 4dc40e2 commit cc3d288
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 3 deletions.
32 changes: 29 additions & 3 deletions docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,32 @@ Event is a piece of code that is triggered when the bot detects something has ha
Command is a piece of coed which is triggered when a user tells the bot to trigger


## Another way of getting bot's information
> print("{0.user}".format(Husky))
> print("{0.user.avatar_url}".format(Husky))
## For assigning roles as soon as user joins
```
intents = discord.Intents.default()
intents.members = True
#? Setting Prefix
Husky = commands.Bot(command_prefix="!", intents=intents)
@Husky.event
async def on_member_join(member):
role = discord.utils.get(member.guild.roles, name="MEMBER")
await member.add_roles(role)
```
*You also have to enable privileged intents in the [developer portal](https://discord.com/developers/applications) - [GUIDE](https://discordpy.readthedocs.io/en/latest/intents.html?highlight=intents)


## For commands starting with a number
```
@Husky.commands(aliases=["4to5"])
async def _4to5(ctx):
...
```


## References
Documentation: [discordpy.readthedocs.io](https://discordpy.readthedocs.io/en/stable/)<br>
Youtube: [youtube.com/playlist](https://www.youtube.com/playlist?list=PLW3GfRiBCHOhfVoiDZpSz8SM_HybXRPzZ)<br>
Colors codes for embeds: [gist.github.com/thomasbnt/...](https://gist.github.com/thomasbnt/b6f455e2c7d743b796917fa3c205f812)<br>
Access google sheets in python using Gspread: [codingpub.dev/access-google-sheets-in-python-using-gspread](https://codingpub.dev/access-google-sheets-in-python-using-gspread)<br>
31 changes: 31 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1 +1,32 @@
![](assets/husky_banner.png)

## What Husky does?
Husky basic work is to take user's information and adds it in a Google Sheets. <br>
Other than this, it can also take some administrator actions.

## Commands
>Prefix: !
1. !husky
2. !register
3. !clear
4. !kick
5. !ban

## Features
1. Provide detailed info how to use commands
2. Register users into our database
3. Gives role to newly registered users
4. Verify if user is already registered
5. Notify when a user joins the server
6. Notify when a user leave the server
7. Can clear a given number of messages (default: 2)
8. Can kick a user
9. Can ban a user

## Technologies Used
1. Google Cloud Platform
2. Google Sheets API
3. Discord Developer Portal
4. Python
5. gspread
6. discord

0 comments on commit cc3d288

Please sign in to comment.