diff --git a/CHANGELOG.md b/CHANGELOG.md index 20c75c6..42f8086 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +# 3.0.0 + +- **[ BREAKING ]** Package renamed to `rescript-react-intl`. +- **[ BREAKING ]** ReScript support + - Now requires ReScript >= 9.1.0 and @rescript/react + - The names of "enum" values now exactly match the names in JavaScript, e.g. `#"2-digit"` instead of `#twoDigit`. + # 2.0.0 * **[ BREAKING ]** `bs-platform >=7.2.2`. * **[ BREAKING ]** `react-intl >=4.0.0`: diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3624cab --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 Alex Fedoseev, Christoph Knittel + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 8be6ca8..6db0aad 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,25 @@ -# bs-react-intl +# rescript-react-intl [](https://nodei.co/npm/bs-react-intl/) -[BuckleScript](https://bucklescript.github.io) bindings to [react-intl]. +[ReScript] bindings to [react-intl]. -To extract messages from [Reason](https://reasonml.github.io) source files for localization, use [bs-react-intl-extractor](https://github.com/cknitt/bs-react-intl-extractor). +To extract messages from [ReScript] source files for localization, use [rescript-react-intl-extractor]. ## Installation + ```shell # yarn -yarn add bs-react-intl +yarn add rescript-react-intl # or npm -npm install --save bs-react-intl +npm install --save rescript-react-intl ``` +Note: If you need version of the bindings that still supports the old Reason syntax, use the old package name `bs-react-intl` instead. + ## Examples + Clone this repo. ```shell @@ -24,9 +28,13 @@ yarn start ``` ## Status -bs-react-intl should cover all of the [react-intl] 3.0.0 API. If you find anything missing, please file an issue. + +rescript-react-intl should cover all of the [react-intl] 3.0.0 API. If you find anything missing, please file an issue. ## Usage + See [`examples`](./examples) folder. -[react-intl]: https://github.com/formatjs/react-intl \ No newline at end of file +[rescript]: https://rescript-lang.org +[react-intl]: https://github.com/formatjs/react-intl +[rescript-react-intl-extractor]: https://github.com/cca-io/rescript-react-intl-extractor diff --git a/bsconfig.json b/bsconfig.json index 682317e..7a44078 100644 --- a/bsconfig.json +++ b/bsconfig.json @@ -1,5 +1,5 @@ { - "name": "bs-react-intl", + "name": "rescript-react-intl", "sources": [ "src", { diff --git a/examples/index.html b/examples/index.html index e6344b6..8f3b9d7 100644 --- a/examples/index.html +++ b/examples/index.html @@ -1,8 +1,8 @@
- -