updateflow 1.0.1 → 1.0.2
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 +1 -1
- package/README.md.save +140 -0
- package/package.json +1 -1
package/README.md
CHANGED
package/README.md.save
ADDED
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
≈# UpdateFlow
|
|
2
|
+
|
|
3
|
+
> **Live OTA updates for Ionic Capacitor apps — No App Store review needed.**
|
|
4
|
+
|
|
5
|
+
Update your app's HTML, CSS, JS — instantly. Without waiting for App Store or Play Store approval.
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/updateflow)
|
|
8
|
+
[](https://updateflow.in)
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## How it works
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
You upload new zip → User opens app → Update downloads silently
|
|
16
|
+
→ User restarts app → New version active ✅
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Quick Start
|
|
22
|
+
|
|
23
|
+
### 1. Install
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npm install updateflow
|
|
27
|
+
npm install cordova-plugin-zip
|
|
28
|
+
npx cap sync
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### 2. iOS setup (one command)
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
node node_modules/updateflow/scripts/ios-setup.js
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Then in Xcode: `Product → Clean Build Folder (Cmd+Shift+K)`
|
|
38
|
+
|
|
39
|
+
### 3. Android setup (one command)
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
node node_modules/updateflow/scripts/android-setup.js
|
|
43
|
+
ionic build && npx cap sync android
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### 4. Add to your Angular app
|
|
47
|
+
|
|
48
|
+
**`app.module.ts`:**
|
|
49
|
+
```typescript
|
|
50
|
+
import { HttpClientModule } from '@angular/common/http';
|
|
51
|
+
|
|
52
|
+
@NgModule({
|
|
53
|
+
imports: [
|
|
54
|
+
HttpClientModule,
|
|
55
|
+
// ...
|
|
56
|
+
]
|
|
57
|
+
})
|
|
58
|
+
export class AppModule {}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
**`app.component.ts`:**
|
|
62
|
+
```typescript
|
|
63
|
+
import { UpdateFlowService } from 'updateflow';
|
|
64
|
+
|
|
65
|
+
@Component({ ... })
|
|
66
|
+
export class AppComponent {
|
|
67
|
+
|
|
68
|
+
constructor(private updateFlow: UpdateFlowService) {}
|
|
69
|
+
|
|
70
|
+
async ngOnInit() {
|
|
71
|
+
await this.updateFlow.init({
|
|
72
|
+
apiUrl: 'https://YOUR_DASHBOARD/check_update.php',
|
|
73
|
+
apiKey: 'YOUR_API_KEY', // Get from UpdateFlow dashboard
|
|
74
|
+
debug: false
|
|
75
|
+
});
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Releasing an Update
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
# 1. Build your app
|
|
86
|
+
ionic build
|
|
87
|
+
|
|
88
|
+
# 2. Create zip from www folder
|
|
89
|
+
cd www && zip -r ../update_2.0.zip . && cd ..
|
|
90
|
+
|
|
91
|
+
# 3. Upload zip to your UpdateFlow dashboard
|
|
92
|
+
# 4. Users will get the update on next app open
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## Configuration
|
|
98
|
+
|
|
99
|
+
| Option | Type | Required | Default | Description |
|
|
100
|
+
|--------|------|----------|---------|-------------|
|
|
101
|
+
| `apiUrl` | `string` | ✅ | — | Your backend URL |
|
|
102
|
+
| `apiKey` | `string` | ✅ | — | API key from dashboard |
|
|
103
|
+
| `showAlerts` | `boolean` | ❌ | `true` | Show update alerts |
|
|
104
|
+
| `debug` | `boolean` | ❌ | `false` | Enable console logs |
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
## API
|
|
109
|
+
|
|
110
|
+
```typescript
|
|
111
|
+
// Check for updates manually
|
|
112
|
+
this.updateFlow.checkNow();
|
|
113
|
+
|
|
114
|
+
// Get current version
|
|
115
|
+
const version = this.updateFlow.getVersion();
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## Platform Support
|
|
121
|
+
|
|
122
|
+
| Platform | Status |
|
|
123
|
+
|----------|--------|
|
|
124
|
+
| iOS | ✅ Supported |
|
|
125
|
+
| Android | ✅ Supported |
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## Links
|
|
130
|
+
|
|
131
|
+
- 🌐 Dashboard: [updateflow.in](https://updateflow.in)
|
|
132
|
+
- 📖 Docs: [updateflow.in/docs](https://updateflow.in/docs)
|
|
133
|
+
- 💬 Support: admin@codecartel.co.in
|
|
134
|
+
- 🐛 Issues: [GitHub Issues](https://github.com/codecartel-in/updateflow/issues)
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
## License
|
|
139
|
+
|
|
140
|
+
MIT © [UpdateFlow](https://updateflow.io)
|