Updated README.md to improve readability

vinkla / hashids

A small PHP library to generate YouTube-like ids from numbers. Use it when you don't want to expose your database ids to the user.

https://hashids.org/php

MIT License

5.27k stars 417 forks source link

Updated README.md to improve readability #124

Closed ignaciogc closed 5 years ago

ignaciogc commented 5 years ago

Nothing major, but there were a few places where the documentation could be clarified / re-worded.

jd327 commented 5 years ago

Thank you @tiny-titan, I like the changes. Two points tho:

I try to avoid using the term "hashed ids". These ids are not technically hashes, since they can be decoded back.
If you have the energy, https://github.com/ivanakimov/hashids.js could use some help too (it's an almost identical README.md copy of this one)

ignaciogc commented 5 years ago

I will take a look at the JS version an update it as well.

The main reasons I decided to use "hashed ids" were:

the library is called hashids anyways, so it should not cause confusion, even if they are not actual irreversible hashes.
In order to differentiate between the input id and the output id.

Let me know if you want me to change those before merging.

jd327 commented 5 years ago

Yep, totally understand. There's a bit of history with using the word "hash" (we even thought about renaming the library at some point). If we could use the terms "id" or "string id" or "output id", I think it'd be better. Personally I prefer just "ids" for the simplicity, but I'm open to other suggestions. The rest of the changes look really good!

ignaciogc commented 5 years ago

I've updated the text to avoid using hashed ids, and instead using output ids.

jd327 commented 5 years ago

Thank you @ignaciogc :+1:

ignaciogc commented 5 years ago

No problem. I'll look at the Javascript version next and update with similar changes.