Compare commits

...
This repository has been archived on 2021-03-28. You can view files and clone it, but cannot push or open issues/pull-requests.

5 Commits

3 changed files with 64 additions and 0 deletions

View File

@ -0,0 +1,29 @@
<!--- Before submitting an issue, check if it hasn't already been submitted by someone else. --->
### Summary
<!--- Describe the issue in a short and concise way. --->
### Steps to reproduce
<!--- List the steps needed to reproduce the issue. --->
### What is the current behavior?
<!--- Describe what's actually happening. --->
### What is the expected behavior?
<!--- Describe what's supposed to happen. --->
### Relevant error messages
<!--- Put any error messages that occur because of this bug here. Please format them in code blocks, as this is much
easier to read. --->
### Possible fixes
<!--- If you can, please link the line(s) you think are responsible for the bug. --->
/label ~bug

View File

@ -0,0 +1,21 @@
<!--- Before submitting a request, check if it hasn't already been submitted by someone else. --->
### The idea
<!--- Describe your idea. Does it fix a certain issue? Does it add new functionality? --->
### Intended users
<!--- Who will be using this new feature? --->
### Proposal
<!--- How do you want to fix this issue? You can give some code snippets, or describe a solution. --->
### Further details
<!--- Here, you can add example use cases, a list of benefits, or any other details that will help us tackle the
issue. --->
/label ~feature

View File

@ -75,3 +75,17 @@ These three decorators are the bread and butter of Frank. Let's break them down:
- `frank.default` defines the command that should be run if the module is called without explicitely giving a command.
For example, if you call `fr examp` without specifying a command, it will run the default command. This is useful for
making a command that's used very often easier to execute.
In the end, all you need to do is the following in your main script:
```python
from frank import Frank
# Or whatever your package containing your modules is called
from modules import ExampleMod
if __name__ == '__main__':
client = Frank([ExampleMod])
client.run(YOUR_DISCORD_TOKEN)
```
You can obtain this token from the Discord developer page.