From 65ecd8ce95c772720e3d5055a77bc1ba1f91aa0b Mon Sep 17 00:00:00 2001 From: Fernando Olivares Date: Tue, 24 Sep 2024 14:59:56 -0600 Subject: [PATCH 1/9] Updated readme --- README.md | 34 ++-------------------------------- 1 file changed, 2 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index cd9f5c0..68cd301 100644 --- a/README.md +++ b/README.md @@ -2,46 +2,16 @@ **Build high-fidelity hybrid apps with native navigation and a single shared web view.** Hotwire Native for iOS provides the tooling to wrap your [Turbo 7](https://github.com/hotwired/turbo)-enabled web app in a native iOS shell. It manages a single WKWebView instance across multiple view controllers, giving you native navigation UI with all the client-side performance benefits of Turbo. -## Features - - **Deliver fast, efficient hybrid apps.** Avoid reloading JavaScript and CSS. Save memory by sharing one WKWebView. - **Reuse mobile web views across platforms.** Create your views once, on the server, in HTML. Deploy them to iOS, [Android](https://github.com/hotwired/turbo-android), and mobile browsers simultaneously. Ship new features without waiting on App 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. -## Requirements - -Hotwire Native iOS is written in Swift 5.3 and requires iOS 14 or higher. It supports web apps using Turbo 7. - -**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://github.com/hotwired/turbo) for details. Ensure that your web app sets the `window.Turbo` global variable as it's required by the native apps: - -```javascript -import { Turbo } from "@hotwired/turbo-rails" -window.Turbo = Turbo -``` - -## Getting Started - -The best way to get started with Hotwire Native iOS to try out the demo app first to get familiar with the framework. The demo app walks you through all the basic Hotwire Native flows as well as some advanced features. To run the demo, clone this repo and open `Demo/Demo.xcodeproj` in Xcode and run the Demo target. 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. - -## Installation - -Add Hotwire Native as a dependency through Xcode or directly to a Package.swift: - -``` -.package(url: "https://github.com/hotwired/hotwire-native-ios", from: "") -``` - -You can also integrate the framework manually if your prefer, such as by adding the repo as a submodule, and linking `Hotwire.framework` to your project. +Read more on [native.hotwired.dev](https://native.hotwired.dev). ## Contributing -Hotwire Native iOS 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-ios). -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-ios/issues). - -Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms. +Please read [CONTRIBUTING.md](./CONTRIBUTING.md). --- From e6456f2a571baa72f6174740b323b7772d824c84 Mon Sep 17 00:00:00 2001 From: Fernando Olivares Date: Tue, 24 Sep 2024 21:31:24 -0600 Subject: [PATCH 2/9] Update ReadMe --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 68cd301..6b90bf9 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # Hotwire Native for iOS -**Build high-fidelity hybrid apps with native navigation and a single shared web view.** Hotwire Native for iOS provides the tooling to wrap your [Turbo 7](https://github.com/hotwired/turbo)-enabled web app in a native iOS shell. It manages a single WKWebView instance across multiple view controllers, giving you native navigation UI with all the client-side performance benefits of Turbo. -- **Deliver fast, efficient hybrid apps.** Avoid reloading JavaScript and CSS. Save memory by sharing one WKWebView. -- **Reuse mobile web views across platforms.** Create your views once, on the server, in HTML. Deploy them to iOS, [Android](https://github.com/hotwired/turbo-android), and mobile browsers simultaneously. Ship new features without waiting on App 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. + +This native Swift library integrates with your [Hotwire](https://hotwired.dev) web app by wrapping it in a native iOS shell. It manages a single WKWebView instance across multiple view controllers, giving you native navigation UI with all the client-side performance benefits of Hotwire. Read more on [native.hotwired.dev](https://native.hotwired.dev). ## Contributing -Please read [CONTRIBUTING.md](./CONTRIBUTING.md). +Hotwire Native for iOS 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/). + +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). ---- +--------- © 2024 37signals LLC From b2c8e59d282cdafac6d2ac5cafb59acb9d49ddfc Mon Sep 17 00:00:00 2001 From: Fernando Olivares Date: Tue, 24 Sep 2024 21:32:10 -0600 Subject: [PATCH 3/9] Remove Demo ReadMe --- Demo/README.md | 10 ---------- 1 file changed, 10 deletions(-) delete mode 100644 Demo/README.md diff --git a/Demo/README.md b/Demo/README.md deleted file mode 100644 index c57e77a..0000000 --- a/Demo/README.md +++ /dev/null @@ -1,10 +0,0 @@ -# Demo - -Open `Demo.xcodeproj` and run the `Demo` app target. By default, the demo app loads a remotely hosted Turbo demo app. The demo app itself describes the various features it supports and you can navigate through the app to explore. - -You can also clone that demo app to experiment from [https://github.com/hotwired/turbo-native-demo](https://github.com/hotwired/turbo-native-demo). Once the local demo server is running, then you just need to change `Demo.current` to use `local` in `Demo/Demo.swift` to point to the local version of the demo. - -

- - -

From 8a15cf1f199c32fc087710e0697f428d93197a27 Mon Sep 17 00:00:00 2001 From: Fernando Olivares Date: Tue, 24 Sep 2024 21:42:14 -0600 Subject: [PATCH 4/9] Update Contributing --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 758c168..afe281c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,9 @@ # Contributing to Hotwire Native iOS +Note that we have a [code of conduct](/CODE_OF_CONDUCT.md). Please follow it in your interactions with this project. + +## Developing locally + To set up your development environment: 1. Clone the repo @@ -10,6 +14,17 @@ To run the test suite: 1. Open the directory in Xcode 1. Click Product → Test or ⌘+U +## 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 Android](https://github.com/hotwired/hotwire-native-android). From 60abb47dff295db79e76387e4c912f5b2e3f7cb2 Mon Sep 17 00:00:00 2001 From: Fernando Olivares Date: Tue, 24 Sep 2024 21:42:37 -0600 Subject: [PATCH 5/9] Rename code of conduct --- CONDUCT.md => CODE_OF_CONDUCT.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CONDUCT.md => CODE_OF_CONDUCT.md (100%) diff --git a/CONDUCT.md b/CODE_OF_CONDUCT.md similarity index 100% rename from CONDUCT.md rename to CODE_OF_CONDUCT.md From cce697565afb0e1cf26fba5edbe1de5d50b4fd56 Mon Sep 17 00:00:00 2001 From: Fernando Olivares Date: Tue, 24 Sep 2024 21:48:26 -0600 Subject: [PATCH 6/9] Add minimum requirements to developing locally --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index afe281c..eb338a7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,10 +4,10 @@ Note that we have a [code of conduct](/CODE_OF_CONDUCT.md). Please follow it in ## Developing locally -To set up your development environment: +Hotwire Native for iOS is built using Swift 5.3 and iOS 14 as its minimum version. To set up your development environment: 1. Clone the repo -1. Open the directory in Xcode to install Swift packages +1. Open the directory in Xcode 15+ to install Swift packages To run the test suite: From bc57e8f7acc8520192c417ad8be77b6a02561fc8 Mon Sep 17 00:00:00 2001 From: Fernando Olivares Date: Tue, 24 Sep 2024 21:51:44 -0600 Subject: [PATCH 7/9] Add shields --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 6b90bf9..c402741 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Hotwire Native for iOS +[![Swift](https://img.shields.io/badge/Swift-5.3-blue) +[![Platforms](https://img.shields.io/badge/iOS-14+-green) [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. From 464edc7eca1c9de69c5ee30c4e6b57a2f9417376 Mon Sep 17 00:00:00 2001 From: Fernando Olivares Date: Tue, 24 Sep 2024 21:52:13 -0600 Subject: [PATCH 8/9] Minor fix --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c402741..54b5fe2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Hotwire Native for iOS -[![Swift](https://img.shields.io/badge/Swift-5.3-blue) -[![Platforms](https://img.shields.io/badge/iOS-14+-green) +![Swift](https://img.shields.io/badge/Swift-5.3-blue) +![Platforms](https://img.shields.io/badge/iOS-14+-green) [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. From 16203f03383c1dd01024cb52ce5ef897070c31b2 Mon Sep 17 00:00:00 2001 From: Fernando Olivares Date: Tue, 24 Sep 2024 21:53:16 -0600 Subject: [PATCH 9/9] Add turbo badge --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 54b5fe2..3476143 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # Hotwire Native for iOS ![Swift](https://img.shields.io/badge/Swift-5.3-blue) -![Platforms](https://img.shields.io/badge/iOS-14+-green) +![iOS](https://img.shields.io/badge/iOS-14+-green) +![Turbo](https://img.shields.io/badge/Turbo-7+-purple) [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.