<h1 align="center">
  <a href="https://rescript-lang.org/">
    ReScript
  </a>
</h1>

<p align="center">
  <strong>Fast, Simple, Fully Typed JavaScript from the Future.</strong>
</p>

<p align="center">
  <a href="https://www.npmjs.org/package/rescript"><img src="https://img.shields.io/npm/v/rescript?color=brightgreen&label=npm%20package" alt="Current npm package version." /></a>
  <a href="https://github.com/rescript-lang/rescript/actions"><img src="https://github.com//rescript-lang/rescript/workflows/CI/badge.svg" alt="Current Github Actions workflow status." /></a>
image:https://img.shields.io/badge/License-MPL--2.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]


## Contents

- [Getting Started](#-getting-started)
- [Documentation](#-documentation)
- [Upgrading](#-upgrading)
- [How to Contribute](#-how-to-contribute)
- [License](#-license)
- [Acknowledgments](#-Acknowledgments)

## 🎉 Getting Started

Follow the [Installation Guide](https://rescript-lang.org/docs/manual/latest/installation) to set up a new ReScript project or integrate ReScript into your existing JavaScript project.

For more information on building React apps with ReScript, see the [rescript-react documentation](https://rescript-lang.org/docs/react/latest/installation).

For React Native apps, see the [rescript-react-native website](https://rescript-react-native.github.io/).

## 📖 Documentation

The full documentation for the ReScript language can be found on our [website](https://rescript-lang.org/).

The source for the ReScript documentation and website is hosted in a [separate repo](https://github.com/rescript-association/rescript-lang.org).

## 🚀 Upgrading

See the [Upgrading Guide](https://rescript-lang.org/docs/manual/latest/installation) for instructions on upgrading to newer ReScript versions.

## 👏 How to Contribute

### [Contributing Guide](CONTRIBUTING.md)

Read our [Contributing Guide](CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to ReScript.

### [Code of Conduct][code]

The ReScript community has adopted a Code of Conduct that we expect project participants to adhere to.
Please read the [full text][code] so that you can understand what actions will and will not be tolerated.

[code]: https://rescript-lang.org/community/code-of-conduct

### [Roadmap][roadmap]

You can learn more about our vision for ReScript in the [Roadmap][roadmap].

[roadmap]: https://rescript-lang.org/community/roadmap

### [Discussions][discussions]

For discussions on ongoing development, see the [Development](https://forum.rescript-lang.org/c/development/8) section of the ReScript forum.

[discussions]: https://rescript-lang.org/community/roadmap

## 📄 License

ReScript is licensed under LGPL version 3, with relaxed rules about creating and distributing combined work. See the [LICENSE](LICENSE) file for details.

The ReScript parser (subdirectory `compiler/syntax`) is licensed under the [MIT License](compiler/syntax/LICENSE).

## 🏅 Acknowledgments

ReScript was originally created by [Hongbo Zhang](https://github.com/bobzhang) in 2015.

See [CREDITS.md](CREDITS.md) for further acknowledgements and project history.
