Update README.md

This commit is contained in:
Gordon Shumway 2019-10-29 01:44:46 -04:00 committed by GitHub
parent b2d1b13eda
commit 5447635234
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 0 additions and 44 deletions

View File

@ -1,45 +1 @@
Forked from https://github.com/reticulatingspline/UrbanDictionary
# Limnoria plugin for UrbanDictionary
## Introduction
Limnoria plugin for querying [UrbanDictionary](http://www.urbandictionary.com)
## Install
You will need a working Limnoria bot on Python 2.7 for this to work.
Go into your Limnoria plugin dir, usually ~/supybot/plugins and run:
```
git clone https://github.com/reticulatingspline/UrbanDictionary
```
To install additional requirements, run:
```
pip install -r requirements.txt
```
Next, load the plugin:
```
/msg bot load UrbanDictionary
```
## Example Usage
```
<spline> @ud spline
<myybot> spline :: The object which Maxis likes to reticulate. [ex:] 1: "What are you reticulating, dude?"2: "My favorite dish-- Splines!" [/ex]
```
## About
All of my plugins are free and open source. When I first started out, one of the main reasons I was
able to learn was due to other code out there. If you find a bug or would like an improvement, feel
free to give me a message on IRC or fork and submit a pull request. Many hours do go into each plugin,
so, if you're feeling generous, I do accept donations via Amazon or browse my [wish list](http://amzn.com/w/380JKXY7P5IKE).
I'm always looking for work, so if you are in need of a custom feature, plugin or something bigger, contact me via GitHub or IRC.