aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar xedre <[email protected]>2018-10-05 22:27:19 +0100
committerGravatar GitHub <[email protected]>2018-10-05 22:27:19 +0100
commita90769721f6e83153a4bbea4ab0bb15a81183bb1 (patch)
tree4ef314e1777e2cb782a72dcb7cbe27b790584771
parentMerge remote-tracking branch 'origin/master' (diff)
added commands and motivation sections to README
also added docstring to templete.py for repository command
-rw-r--r--README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index 3a1c32ad..10439275 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,22 @@
# hacktoberbot
-A community project for Hacktoberfest 2018. A Discord bot primarily designed to help teach Python learners from the PythonDiscord community how to contribute to open source.
+A community project for [Hacktoberfest 2018](https://hacktoberfest.digitalocean.com). A Discord bot primarily designed to help teach Python learners from the PythonDiscord community how to contribute to open source.
You can find our community by going to https://discord.gg/python
+
+## Motivations
+We know it can be difficult to get into the whole open source thing at first. To help out, we've decided to start a little community project during hacktober that you can all choose to contribute to if you're finding the event a little overwhelming, or if you're new to this whole thing and just want someone to hold your hand at first.
+
+by *Lemon*
+
+## Commands
+
+### repository
+Alias: project
+A command to send the hacktoberbot github project
+
+### git
+Alias: github
+A command that sends a getting started with Git page
+
+### git.commit
+Sends a sample first commit