react-native-stallion 2.4.0-alpha.5 β 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +178 -32
- package/android/src/main/cpp/CMakeLists.txt +4 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,76 +1,222 @@
|
|
|
1
1
|
[](https://stalliontech.io/)
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
# Stallion β React Native OTA Updates Made Simple
|
|
3
|
+
# React Native Stallion β Best CodePush Alternative & Expo Updates Replacement
|
|
6
4
|
|
|
7
5
|
[](https://www.npmjs.com/package/react-native-stallion)
|
|
8
6
|
[](https://www.npmjs.com/package/react-native-stallion)
|
|
9
7
|
|
|
10
|
-
**Stallion** is
|
|
8
|
+
**React Native Stallion** is the modern **CodePush alternative** and **App Center replacement** for React Native apps. Ship app updates instantly with **up to 98% smaller patches (depending on changes)**βno app store resubmission required for JavaScript updates. The best **Expo Updates alternative** with advanced OTA controls, patch-based updates, and advanced security features.
|
|
9
|
+
|
|
10
|
+
π **[Sign up with Stallion](https://console.stalliontech.io/)** to start shipping OTA updates today
|
|
11
11
|
|
|
12
12
|
---
|
|
13
13
|
|
|
14
|
-
##
|
|
14
|
+
## Why Choose React Native Stallion?
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
-
|
|
16
|
+
React Native Stallion is the **best CodePush alternative** for teams that need modern OTA update capabilities:
|
|
17
|
+
|
|
18
|
+
- **Up to 98% Smaller Patch Updates (Depending on Changes)** β Binary-safe differential updates, not full bundles
|
|
19
|
+
- **Automatic Rollback & Crash Recovery** β Instant rollback on crashes or failures
|
|
20
|
+
- **Advanced Security Features** β Cryptographic bundle signing with customer keys
|
|
21
|
+
- **No App Store Resubmission for JavaScript Updates** β Ship JavaScript updates instantly
|
|
22
|
+
- **CodePush Compatible** β Easy migration from CodePush or App Center
|
|
23
|
+
- **Advanced Analytics** β Release-wise adoption and failure tracking
|
|
24
|
+
- **On-Premise Option** β Self-hosted deployment with a security-focused architecture
|
|
25
|
+
- **Free Tier Available** β Perfect for indie devs and small teams
|
|
24
26
|
|
|
25
27
|
---
|
|
26
28
|
|
|
27
|
-
##
|
|
29
|
+
## Quick Start
|
|
28
30
|
|
|
29
|
-
###
|
|
31
|
+
### Installation
|
|
30
32
|
|
|
31
33
|
```bash
|
|
32
|
-
npm install
|
|
34
|
+
npm install react-native-stallion@latest
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Basic Usage
|
|
38
|
+
|
|
39
|
+
```javascript
|
|
40
|
+
import { useStallionUpdate, restart } from 'react-native-stallion'
|
|
41
|
+
|
|
42
|
+
const UpdateModal = () => {
|
|
43
|
+
const { isRestartRequired, newReleaseBundle } = useStallionUpdate()
|
|
44
|
+
|
|
45
|
+
if (!isRestartRequired) return null
|
|
46
|
+
|
|
47
|
+
return (
|
|
48
|
+
<Modal visible>
|
|
49
|
+
<Text>{newReleaseBundle?.releaseNote || 'Update ready!'}</Text>
|
|
50
|
+
<Button onPress={restart} title="Restart App" />
|
|
51
|
+
</Modal>
|
|
52
|
+
)
|
|
53
|
+
}
|
|
33
54
|
```
|
|
34
55
|
|
|
35
|
-
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Key Features
|
|
59
|
+
|
|
60
|
+
### Patch Updates (Up to 98% Smaller, Depending on Changes)
|
|
61
|
+
|
|
62
|
+
React Native Stallion uses **binary-safe differential updates** instead of full bundles. Ship only what changedβtiny patches that are cryptographically verified and applied atomically.
|
|
63
|
+
|
|
64
|
+
- **Differential/Patch Updates** β Binary-safe diffs, up to 98% smaller than full bundles (depending on changes)
|
|
65
|
+
- **Bandwidth Efficiency** β Minimal data transfer for faster installs
|
|
66
|
+
- **Instant Updates** β Users never notice the update process
|
|
67
|
+
|
|
68
|
+
### Automatic Rollback & Crash Recovery
|
|
69
|
+
|
|
70
|
+
Protect your users with automatic rollback capabilities:
|
|
71
|
+
|
|
72
|
+
- **Automatic Rollback** β Instant rollback on crashes or failures
|
|
73
|
+
- **Crash Loop Prevention** β Prevents bad updates from breaking your app
|
|
74
|
+
- **Manual Rollback** β Device-level revert for installed updates
|
|
75
|
+
- **Rollback Analytics** β Track rollback rates and reasons
|
|
76
|
+
|
|
77
|
+
### Security-Focused Architecture
|
|
78
|
+
|
|
79
|
+
Advanced security features for production apps:
|
|
80
|
+
|
|
81
|
+
- **Bundle Signing** β Cryptographic verification with customer-managed keys
|
|
82
|
+
- **Integrity Verification** β SHA-256 checksums for tamper-proof updates
|
|
83
|
+
- **On-Premise Hosting** β Deploy behind your firewall with full control
|
|
84
|
+
- **Privacy-Focused Architecture** β Supports regional data residency
|
|
85
|
+
|
|
86
|
+
### Advanced OTA Controls
|
|
87
|
+
|
|
88
|
+
Granular control over update deployment:
|
|
89
|
+
|
|
90
|
+
- **Mandatory & Optional Updates** β CodePush-style update flows
|
|
91
|
+
- **Phased Rollout** β Gradual deployment with percentage controls
|
|
92
|
+
- **Custom Update UI** β Build custom modals, banners, or prompts
|
|
93
|
+
- **Update Strategy Control** β Granular install strategies
|
|
94
|
+
- **Background Updates** β Automatic checks when app moves to foreground
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## π§ Installation & Setup
|
|
99
|
+
|
|
100
|
+
### Step 1: Install the Package
|
|
36
101
|
|
|
37
102
|
```bash
|
|
38
|
-
|
|
103
|
+
npm install react-native-stallion@latest
|
|
104
|
+
# or
|
|
105
|
+
yarn add react-native-stallion@latest
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Step 2: Native Integration
|
|
109
|
+
|
|
110
|
+
For complete setup instructions, native integration steps, and environment configurations, visit:
|
|
111
|
+
|
|
112
|
+
**π [Full Installation Guide](https://learn.stalliontech.io/docs/sdk/installation)**
|
|
113
|
+
|
|
114
|
+
### Step 3: Configure Stallion
|
|
115
|
+
|
|
116
|
+
```javascript
|
|
117
|
+
import { withStallion } from 'react-native-stallion'
|
|
118
|
+
|
|
119
|
+
export default withStallion(RootComponent);
|
|
39
120
|
```
|
|
40
121
|
|
|
41
122
|
---
|
|
42
123
|
|
|
43
|
-
##
|
|
124
|
+
## Documentation & Resources
|
|
125
|
+
|
|
126
|
+
### Complete Documentation
|
|
127
|
+
|
|
128
|
+
- **[Full Documentation](https://learn.stalliontech.io)** β Complete API reference and guides
|
|
129
|
+
- **[SDK Installation](https://learn.stalliontech.io/docs/sdk/installation)** β Step-by-step setup
|
|
130
|
+
- **[Bundle Signing](https://learn.stalliontech.io/docs/bundle-signing)** β Security best practices
|
|
131
|
+
- **[Custom Update UI](https://learn.stalliontech.io/blogs/react-native-over-the-air-updates-with-custom-ui)** β Build custom flows
|
|
132
|
+
- **[CI/CD Integration](https://learn.stalliontech.io/docs/release-automation)** β Automate deployments
|
|
133
|
+
|
|
134
|
+
### Migration Guides
|
|
135
|
+
|
|
136
|
+
- **[CodePush Migration](https://learn.stalliontech.io/docs/migrating-from-codepush)** β Migrate from CodePush
|
|
137
|
+
- **[App Center Migration](https://stalliontech.io/app-center-alternative)** β Replace App Center
|
|
138
|
+
- **[Expo Updates Migration](https://stalliontech.io/expo-eas-update)** β Switch from Expo Updates
|
|
139
|
+
|
|
140
|
+
---
|
|
141
|
+
|
|
142
|
+
## Use Cases
|
|
143
|
+
|
|
144
|
+
### CodePush Alternative
|
|
145
|
+
|
|
146
|
+
React Native Stallion is the **best CodePush alternative** for teams migrating from deprecated CodePush or App Center:
|
|
147
|
+
|
|
148
|
+
- β
CodePush-compatible API
|
|
149
|
+
- β
Patch updates (CodePush doesn't support)
|
|
150
|
+
- β
Active development and support
|
|
151
|
+
- β
Modern features and security
|
|
152
|
+
|
|
153
|
+
### Expo Updates Replacement
|
|
154
|
+
|
|
155
|
+
The best **Expo Updates alternative** with more features:
|
|
156
|
+
|
|
157
|
+
- β
Patch updates (up to 98% smaller, depending on changes)
|
|
158
|
+
- β
Advanced OTA controls
|
|
159
|
+
- β
More affordable pricing
|
|
160
|
+
- β
Works with Expo SDK 52+ and bare React Native
|
|
161
|
+
|
|
162
|
+
### Enterprise OTA Updates
|
|
163
|
+
|
|
164
|
+
Enterprise-ready OTA update solution:
|
|
165
|
+
|
|
166
|
+
- β
On-premise hosting
|
|
167
|
+
- β
Bundle signing with customer keys
|
|
168
|
+
- β
Privacy-focused architecture
|
|
169
|
+
- β
Supports regional data residency
|
|
170
|
+
|
|
171
|
+
---
|
|
172
|
+
|
|
173
|
+
## Security Features
|
|
44
174
|
|
|
45
|
-
|
|
46
|
-
**
|
|
175
|
+
- **Cryptographic Bundle Signing** β Customer-managed keys for tamper-proof updates
|
|
176
|
+
- **SHA-256 Integrity Verification** β Automatic checksum validation
|
|
177
|
+
- **Automatic Crash Detection** β Instant rollback on crashes
|
|
178
|
+
- **On-Premise Deployment** β Full infrastructure control
|
|
179
|
+
- **Audit Logging** β Complete audit trails
|
|
47
180
|
|
|
48
181
|
---
|
|
49
182
|
|
|
50
|
-
##
|
|
183
|
+
## Enterprise & On-Premise
|
|
184
|
+
|
|
185
|
+
### On-Premise Hosting
|
|
186
|
+
|
|
187
|
+
Take full control with self-hosted deployment:
|
|
188
|
+
|
|
189
|
+
- **Security-Focused Architecture** β Behind your firewall
|
|
190
|
+
- **Complete Infrastructure Control** β Your data centers
|
|
191
|
+
- **Privacy-Focused Architecture** β Supports regional data residency
|
|
192
|
+
- **Seamless CI/CD** β REST APIs and webhooks
|
|
193
|
+
- **Zero Vendor Lock-in** β Full access to logs and metrics
|
|
51
194
|
|
|
52
|
-
|
|
53
|
-
**https://learn.stalliontech.io**
|
|
195
|
+
**[Contact sales for on-premise hosting](https://stalliontech.io/)**
|
|
54
196
|
|
|
55
197
|
---
|
|
56
198
|
|
|
57
|
-
##
|
|
199
|
+
## Contributing
|
|
58
200
|
|
|
59
|
-
Please see the [CONTRIBUTING.md](./CONTRIBUTING.md) file to get started
|
|
201
|
+
We welcome contributions! Please see the [CONTRIBUTING.md](./CONTRIBUTING.md) file to get started.
|
|
60
202
|
|
|
61
203
|
---
|
|
62
204
|
|
|
63
|
-
##
|
|
205
|
+
## Issues & Support
|
|
64
206
|
|
|
65
|
-
|
|
207
|
+
- **[Open Issues](https://github.com/stallion-tech/react-native-stallion/issues)** β Report bugs or request features
|
|
208
|
+
- **[Documentation](https://learn.stalliontech.io)** β Complete guides and API reference
|
|
209
|
+
- **[Contact Support](https://stalliontech.io/)** β Get help from our team
|
|
66
210
|
|
|
67
211
|
---
|
|
68
212
|
|
|
69
|
-
##
|
|
213
|
+
## π Links
|
|
70
214
|
|
|
71
|
-
|
|
215
|
+
- **Website:** [https://stalliontech.io](https://stalliontech.io)
|
|
216
|
+
- **Documentation:** [https://learn.stalliontech.io](https://learn.stalliontech.io)
|
|
217
|
+
- **Console:** [https://console.stalliontech.io](https://console.stalliontech.io)
|
|
218
|
+
- **NPM Package:** [https://www.npmjs.com/package/react-native-stallion](https://www.npmjs.com/package/react-native-stallion)
|
|
72
219
|
|
|
73
220
|
---
|
|
74
221
|
|
|
75
|
-
> **Stallion
|
|
76
|
-
> Learn more at: **https://stalliontech.io**
|
|
222
|
+
> **React Native Stallion** β The fastest, safest way to manage React Native OTA updates. The best **CodePush alternative** and **Expo Updates replacement** with patch-based updates, advanced security features, and up to 98% smaller deployments (depending on changes).
|