aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorRenaud G <renaud@rolisteam.org>2018-11-06 13:54:14 +0100
committerGitHub <noreply@github.com>2018-11-06 13:54:14 +0100
commit5c7dede4cd289b80f6e2af877ee1621d91e968d7 (patch)
tree84621b348f7437e67cf498ccc8be50e5246bb30f /README.md
parentbed4de97e598561fa5ec1998e9497a8452d2b073 (diff)
downloadOneRoll-5c7dede4cd289b80f6e2af877ee1621d91e968d7.tar.gz
OneRoll-5c7dede4cd289b80f6e2af877ee1621d91e968d7.zip
Update README.md
improve readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md91
1 files changed, 54 insertions, 37 deletions
diff --git a/README.md b/README.md
index 510a37d..4f49bd6 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,60 @@
# DiceParser
-Rolisteam Dice Parser
+Rolisteam Dice Parser run dice commands. It is available on several platforms.
+The syntax is simple and powerful.
+
+[Full documentation here](https://github.com/Rolisteam/DiceParser/blob/master/HelpMe.md)
+
+
+## [Invite to Your Discord Server](https://discordapp.com/oauth2/authorize?&client_id=279722369260453888&scope=bot&permissions=0)
+
+[![Discord Bots](https://discordbots.org/api/widget/279722369260453888.svg)](https://discordbots.org/bot/279722369260453888)
+
+
+## Features
+
+* `99.9%` uptime
+* Roll any kind of dice
+* Customizable prefix
+* Custom alias/macro to improve game experience
+* Manage colorized dice
+* Many operators
+
+## Examples:
+
+### 3D100
+Roll 3 dice with 100 faces
+
+### 10D10e[=10]s
+Roll 10 dice with 10 faces, 10 explodes, and sort the result.
+
+### 100291D66666666s
+roll 100291 dice with 66666666666 faces and sort result
+
+### 15D10c[>7]
+roll 15 dice with 10 faces and it counts number of dice which are above 7
+
+### 1D8+2D6+7
+roll 1 die with 8 faces and add the result to 2 dice with 6 faces and add 7.
+
+### D25
+roll 1 die with 25 faces
+
+### 88-1D20
+88 minus the value of 1 die of 20 faces
+
+### 8+8+8
+compute: 24
+
+
+
+### 100/28*3
+compute: 100/28 = 3
+3*3 = 9
+
+
+More examples at : https://github.com/Rolisteam/DiceParser/blob/master/HelpMe.md
## Grammar
The grammar is something like this:
@@ -50,39 +103,3 @@ Parenthese =: (expression)
Count =: c Validator
```
-
-## Example:
-
-
-### 3D100
-Roll 3 dice with 100 faces
-
-### 10D10e[=10]s
-Roll 10 dice with 10 faces, 10 explodes, and sort the result.
-
-### 100291D66666666s
-roll 100291 dice with 66666666666 faces and sort result
-
-### 15D10c[>7]
-roll 15 dice with 10 faces and it counts number of dice which are above 7
-
-### 1D8+2D6+7
-roll 1 die with 8 faces and add the result to 2 dice with 6 faces and add 7.
-
-### D25
-roll 1 die with 25 faces
-
-### 88-1D20
-88 minus the value of 1 die of 20 faces
-
-### 8+8+8
-compute: 24
-
-
-
-### 100/28*3
-compute: 100/28 = 3
-3*3 = 9
-
-
-More examples at : https://github.com/Rolisteam/DiceParser/blob/master/HelpMe.md