proton-native/README.md
2021-01-19 22:20:26 -05:00

55 lines
2.2 KiB
Markdown

<p align="center">
<a href="https://proton-native.js.org">
<img alt="proton native" src="http://protonnative-af51.kxcdn.com/images/logo_black.svg?">
</a>
Logo by <a href="https://twitter.com/elisiri_">@elisiri</a>
</p>
# Announcement
**Sadly I don't have time to dedicate time to this project. Some others have created a fork here to continue the work: https://github.com/proton-nativejs/proton-native**
[![npm](https://img.shields.io/npm/v/proton-native.svg)](https://www.npmjs.com/package/proton-native)
[![npm](https://img.shields.io/npm/dm/proton-native.svg)](https://www.npmjs.com/package/proton-native)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
[![MIT License](https://img.shields.io/github/license/kusti8/proton-native.svg)](https://github.com/kusti8/proton-native/blob/master/LICENSE)
[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/Proton-Native)
Create desktop applications through a React syntax, on all platforms.
## V2 is released!
V2 has been released and it brings a whole host of improvements including new
components that are identical to React Native, styling, flexbox, hot reloading,
and more. You can read the full writeup [here](https://proton-native.js.org/#/v2_changes).
To try it out, visit the documentation for instructions on how to get started!
## Features
- Same syntax and components as React Native
- Works with existing React libraries such as Redux
- Cross platform
- No more Electron
- Compatible with all normal Node.js packages
- Hot reloading
## Images
<span style="display: flex;">
<img src="docs/calculator.png" height="400" style="margin: 10;">
<img src="docs/catapi_v2.png" style="margin: 10;">
</span>
## [Documentation](https://proton-native.js.org)
See the documentation for how to get started and details on all the components.
## Examples
Examples can be found in [`examples/`](https://github.com/kusti8/proton-native/tree/master/examples).
## Contributing
All contributions are welcome. Just make a PR.
<a href="https://www.keycdn.com/"><sub><sup>Accelerated by KeyCDN</sup></sub></a>