diff --git a/api.md b/api.md new file mode 100644 index 0000000..65ee01d --- /dev/null +++ b/api.md @@ -0,0 +1,5 @@ +# ranks API +Currently this mod provides 3 global functions: +* `ranks.get_rank(name)` - returns two variables(strings): rank, color +* `ranks.set_rank(name, rank, color)` - used to set rank for specified player +* `ranks.del_rank(name)` - used to remove rank of specified player