Skip to content

Commit 0d79152

Browse files
committed
Modify the readme .
1 parent 3fd4489 commit 0d79152

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,4 +75,21 @@ $hashids = new Hashids();
7575

7676
$hash = $hashids->encodeHex('FFFFDD'); // rYKPAK
7777
$numbers = $hashids->decodeHex($hash); // FFFFDD
78-
```
78+
```
79+
80+
Curses! #$%@
81+
82+
-------
83+
84+
This code was written with the intent of placing created ids in visible places, like the URL. Therefore, the algorithm tries to avoid generating most common English curse words by generating ids that never have the following letters next to each other:
85+
86+
c, f, h, i, s, t, u
87+
88+
License
89+
90+
-------
91+
92+
MIT License. See the [LICENSE](LICENSE) file. You can use Hashids in open source projects and commercial products. Don't break the Internet. Kthxbye.
93+
94+
[license-url]: https://github.com/cdoco/grank/blob/master/LICENSE
95+
[license-image]: https://img.shields.io/badge/License-MIT-blue.svg

0 commit comments

Comments
 (0)