Skip to content

Commit 1a89814

Browse files
authored
Added some details about the bot
1 parent e9c678c commit 1a89814

File tree

1 file changed

+15
-22
lines changed

1 file changed

+15
-22
lines changed

README.md

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,18 @@
1-
# Code Roller CLI
2-
The official Code Roller Cli
1+
# Shurl
2+
The bot that shortens a url for you
3+
<hr>
4+
5+
## What is shurl
6+
Shurl is a discord bot that allowes users to shorten urls.
7+
The Shurl bot is created by Code Roller.
38

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

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

15-
## Credits
16-
Created by these members of the Code Roller team
17-
<table>
18-
<tr>
19-
<td>
20-
<a href="https://github.com/code-roller/code-roller-cli/graphs/contributors">
21-
<img src="https://contrib.rocks/image?repo=code-roller/code-roller-cli" />
22-
</a>
23-
</td>
24-
</tr>
25-
</table>
15+
## How does the bot work ?
16+
The bot uses the rebrand api to shorten urls .
17+
18+
<hr>

0 commit comments

Comments
 (0)