Skip to content

Commit 128c824

Browse files
committed
Update README.md
1 parent 9f1334e commit 128c824

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Openmoji for React
22

3-
unofficial; bodged by drinking-code
4-
not optimized for production use
3+
unofficial; bodged by drinking-code
54

65
1. [What is Openmoji for React?](#what-is-openmoji-for-react)
76
2. [Installation](#installation)
@@ -69,7 +68,7 @@ export default App;
6968

7069
#### `replaceEmojis(string[, options])`
7170

72-
Is the sting equivalent to `reactReplaceEmojis`. Use this if you only want to replace emojis within a string.
71+
Is the string equivalent to `reactReplaceEmojis`. Use this if you just want to replace emojis within a string.
7372

7473
```jsx
7574
import React from 'react';
@@ -97,15 +96,15 @@ const App = () => {
9796
export default App;
9897
```
9998

100-
Icon names from the [Openmoji Library](https://openmoji.org/library/) are converted into camelCase,
99+
Icon names from the [Openmoji Library](https://openmoji.org/library/) are converted into PascalCase,
101100
so `man raising hand` translates to `ManRaisingHand`.
102101

103102
##### Additions
104103

105-
`:` are replaced with `_`.
104+
`:` is replaced with `_`.
106105

107106
```
108-
waving hand: light skin tone -> WavingHand_LightSkinTone
107+
waving hand: light skin tone -> WavingHand_LightSkinTone
109108
```
110109

111110
`,`, `.`, ``, `!`, ``, and `&` are removed.
@@ -122,8 +121,8 @@ flag: Bosnia & Herzegovina -> Flag_BosniaHerzegovina
122121
`#` is replaced with `NumberSign`, `*` is replaced with `Asterisk`.
123122

124123
```
125-
keycap: # -> Keycap_NumberSign
126-
keycap: * -> Keycap_Asterisk
124+
keycap: # -> Keycap_NumberSign
125+
keycap: * -> Keycap_Asterisk
127126
```
128127

129128
Everything in brackets is removed.
@@ -138,9 +137,11 @@ If a name starts with a number, a `_` is added in front of the name.
138137
1st place medal -> _1stPlaceMedal
139138
```
140139

140+
> **Note:** Some names may appear more than once in the Library (i.e. some emoji variations). Those duplicates are renamed to `DuplicatedName2`, `DuplicatedName3` etc.
141+
141142
#### Via unicode
142143

143-
You can use the unicode of the emoji to import it. Unicodes are listed also in
144+
You can use the unicode of the emoji to import it. Unicodes are also listed in
144145
the [Openmoji Library](https://openmoji.org/library/). All unicode names have the `U_` prefix in `react-openmoji`.
145146

146147
```jsx
@@ -154,7 +155,7 @@ const App = () => {
154155
export default App;
155156
```
156157

157-
You can also include all 3914 emojis:
158+
> **Fun fact:** Importing all 3914 emojis at once is actually just as fast as the other methods because all emojis are dynamically loaded:
158159
159160
```jsx
160161
import React from 'react';
@@ -169,7 +170,7 @@ export default App;
169170

170171
#### Attributes
171172

172-
In all manual cases you can use two attributes:
173+
With all manual methods you can use two attributes:
173174

174175
|Field|Type|Description|Default|
175176
|---|---|---|---|

0 commit comments

Comments
 (0)