jdecked / twemoji-parser

A simple library for identifying emoji entities within a string in order to render them as Twemoji.
MIT License
19 stars 6 forks source link

docs: 📝 Change package name to `@twemoji/parser` #5

Closed ThatOneCalculator closed 10 months ago

ThatOneCalculator commented 10 months ago

ref: https://github.com/jdecked/twemoji-parser/issues/3#issuecomment-1837165409

Problem

Explain the context and why you're making that change. What is the problem you're trying to solve? In some cases there is not a problem and this can be thought of being the motivation for your change.

The documentation still mentions twemoji-parser despite being deprecated

Solution

Describe the modifications you've done.

The documentation now points to @twemoji/parser, as well as adding a note about the change.

Result

What will change as a result of your pull request? Note that sometimes this section is unnecessary because it is self-explanatory based on the solution.

Users reading the readme will now be guided to the right package