Misc doc changes

[kianmeng]

List of changes:

• Use common source url
• Set readme as main html page
• Fix typos
• Add changelog to html doc
• Add changelog link to hex module doc
• Add upgrade to v5 to html doc
• Update license year and format doc
• Add missing arity for function doc

[riverrun]

This is great! Thanks for your contribution.

I am going to merge these changes, but I have a question about the use of the word present in the copyright notice. I haven't seen it before, but checking online, I saw this stackexchange post, where they say it's not a good idea. Do you have any references which can clarify that it's ok to use the word present to mean this year?

[kianmeng]

This is great! Thanks for your contribution.

I am going to merge these changes, but I have a question about the use of the word present in the copyright notice. I haven't seen it before, but checking online, I saw this stackexchange post, where they say it's not a good idea. Do you have any references which can clarify that it's ok to use the word present to mean this year?

Good that you raised this issue. ;-)

I remembered I saw its usage in the React project in the past but it seemed that they have remove the year entirely from the copyright header due to their guideline (tried but can't find it).

IANAL.
Since this Elixir module is licensed under the BSD license, a date range of 2014-2021 should be sufficient instead of present.
Also, I've noticed the SPDX identifier in mix.exs should be updated from BSD to BSD-3-Clause based on the SPDX list and the content of LICENSE is similar (not word-for-word) to BSD-3-Clause.

Do you want me to create a PR for these changes?

[riverrun]

Since this Elixir module is licensed under the BSD license, a date range of 2014-2021 should be sufficient instead of present.

Sounds good.

Also, I've noticed the SPDX identifier in mix.exs should be updated from BSD to BSD-3-Clause based on the SPDX list and the content of LICENSE is similar (not word-for-word) to BSD-3-Clause.

Do you want me to create a PR for these changes?

Yes, that would be great. And thanks for the info.