Skip to content

Commit

Permalink
Update README.md for poll plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
bmamlin committed Apr 9, 2014
1 parent 8cdf255 commit b694b19
Showing 1 changed file with 23 additions and 13 deletions.
36 changes: 23 additions & 13 deletions plugins/poll/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,30 @@ Allows you to add a poll to the first post of a topic.
# Usage

1. Make your topic title start with "Poll: "
2. Include a list in your post. The **first list** will be used.
* If you don't want it to be the first list, do this:
2. Include a list in your post (the **first list** will be used)

```
Intro Text
## Closing the poll

Change the start of the topic title from "Poll: " to "Closed Poll: "

_Note: closing a topic will also close the poll._

## Specifying the list to be used for the poll

If you have multiple lists in your post and the first list is _not_
the one you want to use for the poll, you can identify the
list to be used like this:

```
Intro Text
- Some list
- Some list con't
- Item one
- Item two
Here are your choices:
Here are your choices:
[poll]
- Option 1
- Option 2
[/poll]
```

[poll]
- Option 1
- Option 2
[/poll]
```

0 comments on commit b694b19

Please sign in to comment.