Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation #9

Merged
merged 1 commit into from
Sep 19, 2023
Merged

Documentation #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 6 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,21 @@
# Strada

Strada is a library that provides a bridge for communicating between native iOS/Android apps and web app embedded in a web view. The bridge allows bi-directional sending of messages with a standard format.
[Strada](https://strada.hotwired.dev) enables you to create native controls in your hybrid mobile apps, driven by the web. Build web components and native components that work together in `WebView` screens to elevate your [Turbo Native](https://turbo.hotwired.dev/handbook/native) apps to the next level.

Strada works seamlessly with your [Turbo Native](https://turbo.hotwired.dev/handbook/native) apps and leverages [Stimulus]((https://stimulus.hotwired.dev)) to create web components with your existing HTML. The `strada-web` library is designed to work together with the [strada-ios](https://github.com/hotwired/strada-ios) and [strada-android](https://github.com/hotwired/strada-android) native libraries.

## Installation
Strada for web can be installed through npm or yarn from the GitHub repo until the package is published:

```
npm install --save-dev @hotwired/strada
```
Read more on [strada.hotwired.dev](https://strada.hotwired.dev).

You can also install manually by running `npm run build` and copying `dist/strada.js` into your app.

## Contributing

Strada Web is open-source software, freely distributable under the terms of an [MIT-style license](LICENSE). The [source code is hosted on GitHub](https://github.com/hotwired/strada-web). Development is sponsored by [37signals](https://37signals.com/).
Strada is open-source software, freely distributable under the terms of an [MIT-style license](LICENSE). The [source code is hosted on GitHub](https://github.com/hotwired/strada-web). Development is sponsored by [37signals](https://37signals.com/).

We welcome contributions in the form of bug reports, pull requests, or thoughtful discussions in the [GitHub issue tracker](https://github.com/hotwired/strada-web/issues).
We welcome contributions in the form of bug reports, pull requests, or thoughtful discussions in the [GitHub issue tracker](https://github.com/hotwired/strada-web/issues).

Please note that this project is released with a [Contributor Code of Conduct](docs/CONDUCT.md). By participating in this project you agree to abide by its terms.

---------

© 2022 37signals, LLC
© 2023 37signals LLC