Merge pull request #58 from hotwired/readme-updates

Readme updates

CODE_OF_CONDUCT.md

@@ -0,0 +1,78 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting one of the project maintainers listed below. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Project Maintainers
+
+* Jay Ohms <<jay@37signals.com>>
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing to Hotwire Native Android
+
+Note that we have a [code of conduct](/CODE_OF_CONDUCT.md). Please follow it in your interactions with this project.
+
+## Developing locally
+
+Hotwire Native for Android is built using Kotlin and Android SDK 28+ as its minimum version. To set up your development environment:
+
+1. Clone the repo
+1. Open the directory in the latest version of Android Studio
+
+To run the test suite:
+
+1. Open the directory in Terminal
+1. Run the `./gradlew testRelease` command
+
+## Sending a Pull Request
+
+The core team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation.
+
+Before submitting a pull request, please:
+
+1. Fork the repository and create your branch.
+2. Follow the setup instructions in this file.
+3. If you’re fixing a bug or adding code that should be tested, add tests!
+4. Ensure the test suite passes.
+
+## Feature parity with Android
+
+New features will not be merged until also added to [Hotwire Native iOS](https://github.com/hotwired/hotwire-native-ios).
+
+This does not apply to bugs that only appear on Android.

README.md

@@ -1,43 +1,19 @@
 # Hotwire Native for Android
 
-**Build high-fidelity hybrid apps with native navigation and a single shared web view**. Hotwire Native for Android provides the tooling to wrap your [Turbo 7](https://turbo.hotwired.dev/)-enabled web app in a native Android shell. It manages a single WebView instance across multiple Fragment destinations, giving you native navigation UI with all the client-side performance benefits of Turbo.
+![Android SDK](https://img.shields.io/badge/Android%20SDK-28+-green)
+![Turbo](https://img.shields.io/badge/Turbo-7+-purple)
 
-## Features
-- **Deliver fast, efficient hybrid apps.** Avoid reloading JavaScript and CSS. Save memory by sharing one WebView.
-- **Reuse mobile web views across platforms.** Create your views once, on the server, in HTML. Deploy them to [iOS](https://github.com/hotwired/turbo-ios), Android, and mobile browsers simultaneously. Ship new features without waiting on Play Store approval.
-- **Enhance web views with native UI.** Navigate web views using native patterns. Augment web UI with native controls.
-- **Produce large apps with small teams.** Achieve baseline HTML coverage for free. Upgrade to native views as needed.
+[Hotwire Native](https://native.hotwired.dev) is a high-level native framework, available for iOS and Android, that provides you with all the tools you need to leverage your web app and build great mobile apps.
 
-## Requirements
+This native Kotlin library integrates with your [Hotwire](https://hotwired.dev) web app by wrapping it in a native Android shell. It manages a single `WebView` instance across multiple destinations, giving you native navigation UI with all the client-side performance benefits of Hotwire.
 
-1. Android SDK 28+ is required as the `minSdk` in your `build.gradle.kts` file.
-1. This library is written entirely in [Kotlin](https://kotlinlang.org/), and your app should use Kotlin as well. Compatibility with Java is not provided or supported.
-1. This library supports web apps using either Turbo 7 or Turbolinks 5.
-1. `Turbo` (or `Turbolinks`) is exposed on the `window` object on the WebView page being loaded.
-
-**Note:** You should understand how Turbo works with web applications in the browser before attempting to use Hotwire Native. See the [Turbo 7 documentation](https://turbo.hotwired.dev) for details.
-
-## Getting Started
-The best way to get started with Hotwire Native Android is to try out the demo app first to get familiar with the framework. The demo app walks you through all the basic Turbo flows as well as some advanced features. To run the demo, clone this repo, open the directory in Android Studio, and build the `demo` module to your Android device. See [demo/README.md](demo/README.md) for more details about the demo. When you’re ready to start your own application, read through the rest of the documentation.
-
-See the [instructions to build the project yourself](docs/BUILD-PROJECT.md).
-
-## Documentation
-
-1. [Installation](docs/INSTALLATION.md)
-1. [Overview](docs/OVERVIEW.md)
-1. [Quick Start](docs/QUICK-START.md)
-1. [Path Configuration](docs/PATH-CONFIGURATION.md)
-1. [Navigation](docs/NAVIGATION.md)
-1. [Advanced Options](docs/ADVANCED-OPTIONS.md)
+Read more on [native.hotwired.dev](https://native.hotwired.dev).
 
 ## Contributing
 
-Hotwire Native Android 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/hotwire-native-android). 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/hotwire-native-android/issues).
+Hotwire Native for Android 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/hotwire-native-bridge). Development is sponsored by [37signals](https://37signals.com/).
 
-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.
+We welcome contributions in the form of bug reports, pull requests, or thoughtful discussions in the [GitHub issue tracker](https://github.com/hotwired/hotwire-native-bridge/issues).
 
 ---------