diff --git a/.gitlab/issue_templates/Bug.md b/.gitlab/issue_templates/Bug.md new file mode 100644 index 0000000..a53f0d2 --- /dev/null +++ b/.gitlab/issue_templates/Bug.md @@ -0,0 +1,29 @@ + + +### Summary + + + +### Steps to reproduce + + + +### What is the current behavior? + + + +### What is the expected behavior? + + + +### Relevant error messages + + + +### Possible fixes + + + + +/label ~bug diff --git a/.gitlab/issue_templates/Feature Request.md b/.gitlab/issue_templates/Feature Request.md new file mode 100644 index 0000000..809e5bf --- /dev/null +++ b/.gitlab/issue_templates/Feature Request.md @@ -0,0 +1,21 @@ + + +### The idea + + + +### Intended users + + + +### Proposal + + + +### Further details + + + + +/label ~feature diff --git a/README.md b/README.md index 142d880..e7fb410 100644 --- a/README.md +++ b/README.md @@ -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.