Skip to content

Commit

Permalink
Added some details about the bot
Browse files Browse the repository at this point in the history
  • Loading branch information
lainq authored Mar 30, 2021
1 parent e9c678c commit 1a89814
Showing 1 changed file with 15 additions and 22 deletions.
37 changes: 15 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,18 @@
# Code Roller CLI
The official Code Roller Cli
# Shurl
The bot that shortens a url for you
<hr>

## What is shurl
Shurl is a discord bot that allowes users to shorten urls.
The Shurl bot is created by Code Roller.

## Usage
To install:
```
code-roller install $package$
```
where package can be anything in [requirements.txt](requirements.txt)
## How to use it??
Shurl can be used with the Prefix `^shurl` followed by the url.
`shurl https://github.com/code-roller/shurl-discord-bot`

## License
The code roller cli is licensed under the
MIT License. You can read the license from [here](LICENSE)
<hr>

## Credits
Created by these members of the Code Roller team
<table>
<tr>
<td>
<a href="https://github.com/code-roller/code-roller-cli/graphs/contributors">
<img src="https://contrib.rocks/image?repo=code-roller/code-roller-cli" />
</a>
</td>
</tr>
</table>
## How does the bot work ?
The bot uses the rebrand api to shorten urls .

<hr>

0 comments on commit 1a89814

Please sign in to comment.