Skip to content

Commit 5a25d99

Browse files
committed
Updated README.
1 parent b6124fe commit 5a25d99

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,44 @@
22

33
Extracts messages for localization from [Reason] source files.
44

5-
This assumes that you are using the
6-
[bs-react-intl] bindings for [react-intl] and your source files define formatted messages as follows:
5+
This assumes that you are using the [bs-react-intl] bindings for [react-intl]
6+
and your source files define formatted messages either inline in `FormattedMessage`:
77

88
```re
99
<FormattedMessage id="some.message.id" defaultMessage="Some message" />
1010
```
1111

12+
or using `ReactIntl.defineMessages`:
13+
14+
```
15+
let messages =
16+
ReactIntl.defineMessages(. {
17+
"hello": {
18+
"id": "message.hello",
19+
"defaultMessage": "Hello",
20+
},
21+
"world": {
22+
"id": "message.world",
23+
"defaultMessage": "World",
24+
},
25+
});
26+
```
27+
1228
The output (a JSON array of all extracted messages sorted by id) is written to stdout. It will look like this:
1329

1430
```
1531
[
1632
{
17-
"id": "some.message.id",
18-
"defaultMessage": "Some message"
33+
"id": "message.hello",
34+
"defaultMessage": "Hello"
35+
},
36+
{
37+
"id": "message.world",
38+
"defaultMessage": "World"
1939
},
2040
{
21-
"id": "some.other.message.id",
22-
"defaultMessage": "Some other message"
41+
"id": "some.message.id",
42+
"defaultMessage": "Some message"
2343
},
2444
...
2545
]

0 commit comments

Comments
 (0)