Skip to content

Commit ddca605

Browse files
committed
Added license and readme.
1 parent 378a93f commit ddca605

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018 Christoph Knittel
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# bs-react-intl-extractor-bin
2+
3+
macOS and Linux (64-bit) binaries for [bs-react-intl-extractor].
4+
5+
[bs-react-intl-extractor] extracts messages for localization from [Reason] source files.
6+
This assumes that you are using the [bs-react-intl] bindings for [react-intl].
7+
8+
## Installation
9+
10+
This package may be installed globally or locally with either `npm` or `yarn`.
11+
12+
For example, run
13+
14+
```sh
15+
npm install -g bs-react-intl-extractor-bin
16+
```
17+
18+
for global installation.
19+
20+
## Usage
21+
22+
After global installation, `bs-react-intl-extractor` will be available in your path. Run e.g.
23+
24+
```sh
25+
bs-react-intl-extractor src
26+
```
27+
28+
to extract messages from all Reason source files below `src`.
29+
30+
For more information, see the [bs-react-intl-extractor] repo.
31+
32+
[bs-react-intl]: https://github.com/alexfedoseev/bs-react-intl
33+
[bs-react-intl-extractor]: https://github.com/cknitt/bs-react-intl-extractor
34+
[react-intl]: https://github.com/yahoo/react-intl
35+
[reason]: https://reasonml.github.io

0 commit comments

Comments
 (0)