Skip to content

Commit

Permalink
add screenshot to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zhudotexe committed Mar 7, 2021
1 parent 24611a3 commit a703fc9
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,19 @@ PaissaHouse is a simple plugin that runs in the background: when you view a hous
## Usage
Simply install and it will happily run in the background.

// TODO: add image of it working here.

Use `/psweep` to open configuration, and `/psweep reset` to reset the internal sweep cache if you want to sweep the same district multiple times in a row.

| Setting | Description | Default |
|--------------------|------------------------------------------------------------------------------------------------------|---------|
| Enabled | Whether or not the plugin is enabled. If disabled, it will not look for houses. | True |
| Output Format | The format results are displayed in. | Simple |

<figure>
<img src="https://cdn.discordapp.com/attachments/263128686004404225/817965077982085120/unknown.png">
<figcaption>The result of tabbing through all 24 wards in a few different districts.</figcaption>
</figure>


## FAQ

### Can this plugin automatically sweep for me?
Expand Down

0 comments on commit a703fc9

Please sign in to comment.