From 16ea41bfc052b8237c47f8685678b1b62cbfa081 Mon Sep 17 00:00:00 2001 From: JamesMCo Date: Mon, 2 Oct 2017 20:29:21 +0100 Subject: [PATCH] Update readme to fix formatting - Now includes a brief description of what Hackbot does - Available commands rearranged into a table --- README.md | 44 +++++++++++++++++--------------------------- 1 file changed, 17 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 0a9b156..f03240b 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,19 @@ # hubot-hackbot [![Build Status](https://travis-ci.org/TechNottingham/hubot-hackbot.svg?branch=master)](https://travis-ci.org/TechNottingham/hubot-hackbot) -#How to use Hackbot -##Create a Team -`@hackbot create team Best Team Ever` - -##Add a teammate -`@hackbot add @BillSmith to my team` - -##Set your team motto -`@hackbot our motto is We are the bestest` - -##Leave your Team -`@hackbot leave my team` - -##Find out about your Team -`@hackbot tell me about my team` - -##Find out about any Team -`@hackbot tell me about team Strangers` - -##Find out about any hacker -`@hackbot tell me about @BillSmith` - -##Search for a team name -`@hackbot find teams like Str` - -#Full Instructions -[http://www.hack24.co.uk/how-to-use-hackbot](http://www.hack24.co.uk/how-to-use-hackbot) +# What is Hackbot? +Hackbot is your first point of contact for all things relating to the management of your teams and hacks at [Hack24](http://www.hack24.co.uk). + +# How to use Hackbot +| Action | Command | +| ------------------------- | ------------------------------------------ | +| Create a Team | `@hackbot create team Best Team Ever` | +| Add a teammate | `@hackbot add @BillSmith to my team` | +| Set your team motto | `@hackbot our motto is We are the bestest` | +| Leave your Team | `@hackbot leave my team` | +| Find out about your Team | `@hackbot tell me about my team` | +| Find out about any Team | `@hackbot tell me about team Strangers` | +| Find out about any hacker | `@hackbot tell me about @BillSmith` | +| Search for a team name | `@hackbot find teams like Str` | + +# Full Instructions +For full instructions on how to use HackBot, please see the [Hack24 website](http://www.hack24.co.uk/how-to-use-hackbot). \ No newline at end of file