Skip to content

Commit 933cfe8

Browse files
authored
Merge pull request #9 from cknitt/feature/0.4.0
Update README and CHANGELOG for 0.4.0.
2 parents ddcbbb5 + 1ceb4b2 commit 933cfe8

File tree

2 files changed

+25
-23
lines changed

2 files changed

+25
-23
lines changed

CHANGELOG.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Changelog
22

3+
## 0.4.0 - 2018-05-25
4+
5+
* Directly use Reason parser api instead of forking the refmt exe for each file.
6+
Message extraction is now lightning fast! 😀
7+
* Command line args
8+
* allow multiple source directories to be specified
9+
* support -v and -help options
10+
* Support message extraction when `open ReactIntl;` was used.
11+
* Added tests + Travis CI.
12+
313
## 0.3.0 - 2018-05-16
414

515
* Support `[@intl.messages]` for marking messages for extraction.
@@ -11,4 +21,4 @@
1121

1222
## 0.1.0 - 2018-05-13
1323

14-
Initial Release.
24+
* Initial Release.

README.md

Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,21 @@
33
[![Build Status](https://travis-ci.org/cknitt/bs-react-intl-extractor.svg?branch=master)](https://travis-ci.org/cknitt/bs-react-intl-extractor)
44

55
Extracts messages for localization from [Reason] source files.
6+
This assumes that you are using the [bs-react-intl] bindings for [react-intl].
67

7-
This assumes that you are using the [bs-react-intl] bindings for [react-intl]
8-
and your source files define formatted messages in one of the following three ways:
8+
## Installation
9+
10+
macOS and Linux binaries are available for download on the [releases page].
11+
12+
## Usage
13+
14+
```sh
15+
bs-react-intl-extractor [path...]
16+
```
17+
18+
where `path` is a Reason source file or a directory containing Reason source files. Multiple files/directories may be specified.
19+
20+
Formatted messages may be defined in your source files in one of the following three ways:
921

1022
1. inline in `FormattedMessage`:
1123

@@ -91,26 +103,6 @@ The output (a JSON array of all extracted messages sorted by id) is written to s
91103
]
92104
```
93105

94-
## Download
95-
96-
macOS and Linux binaries are available for download on the [releases page].
97-
98-
After you have downloaded a binary, make it executable using `chmod +x`.
99-
100-
## Usage
101-
102-
```sh
103-
bs-react-intl-extractor directory ...
104-
```
105-
106-
where `directory` is a directory containing Reason source files. Multiple directories may be specified.
107-
108-
The reason formatter (`refmt`) needs to be on the path.
109-
110-
## Known Issues
111-
112-
Performance is not optimal right now as the `refmt` executable is forked for the processing of each file.
113-
114106
## How to build
115107

116108
Install [esy] as follows:

0 commit comments

Comments
 (0)