Skip to content

Commit 32e2f9c

Browse files
committed
docs(README): revert license description, additional instructions for cache cleanup, move warnings to the Important Notes section
1 parent 83313f6 commit 32e2f9c

1 file changed

Lines changed: 28 additions & 5 deletions

File tree

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ This package lets you start Vapi calls directly in your React Native app.
2525
- **This guide is for bare React Native projects**. If you use **expo build**, skip to the [Expo Integration](#expo-integration)
2626
- **Requires React Native 0.60+** for autolinking support
2727
- **Not compatible with Expo Go** - requires custom native code
28+
- **Not compatible with TurboModules** - requires `newArchEnabled=false` in `android/gradle.properties`
2829

2930
## 📋 Prerequisites
3031

@@ -42,6 +43,8 @@ This package lets you start Vapi calls directly in your React Native app.
4243
### Android
4344
- **Minimum SDK**: 24
4445

46+
⚠️ If you are running into issues with TurboModules, you might need to disable `newArchEnabled` in your `android/gradle.properties` file.
47+
4548
## 🔧 Installation
4649

4750
### Step 1: Install Dependencies
@@ -131,8 +134,6 @@ If you view the raw file contents of `Info.plist`, it should look like this:
131134
minSdkVersion = 24
132135
```
133136

134-
If you are running into issues with TurboModules, you might need to disable `newArchEnabled` in your `android/gradle.properties` file.
135-
136137
```properties
137138
newArchEnabled=false
138139
```
@@ -177,7 +178,7 @@ try {
177178
await vapi.start({
178179
model: {
179180
provider: 'openai',
180-
model: 'gpt-4',
181+
model: 'gpt-4o',
181182
messages: [
182183
{
183184
role: 'system',
@@ -271,6 +272,12 @@ cd ios && rm -rf Pods Podfile.lock && pod install && cd ..
271272
npx react-native start --reset-cache
272273
```
273274

275+
#### 5. **TurboModules Issues**
276+
```bash
277+
# Disable TurboModules
278+
cd android && echo 'newArchEnabled=false' >> gradle.properties && cd ..
279+
```
280+
274281
### Debug Commands
275282

276283
```bash
@@ -281,7 +288,7 @@ cd ios && xcodebuild clean && cd ..
281288
cd android && ./gradlew clean && cd ..
282289

283290
# Reinstall dependencies
284-
rm -rf node_modules && npm install
291+
rm -rf node_modules && npm cache verify && npm install
285292
```
286293

287294
## 🔗 Expo Integration
@@ -365,7 +372,23 @@ new Vapi(apiKey: string, apiBaseUrl?: string)
365372

366373
## 📄 License
367374

368-
ISC License - see LICENSE file for details.
375+
MIT License
376+
Copyright (c) 2023 Vapi Labs Inc.
377+
Permission is hereby granted, free of charge, to any person obtaining a copy
378+
of this software and associated documentation files (the "Software"), to deal
379+
in the Software without restriction, including without limitation the rights
380+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
381+
copies of the Software, and to permit persons to whom the Software is
382+
furnished to do so, subject to the following conditions:
383+
The above copyright notice and this permission notice shall be included in all
384+
copies or substantial portions of the Software.
385+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
386+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
387+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
388+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
389+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
390+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
391+
SOFTWARE.
369392

370393
## 🆘 Support
371394

0 commit comments

Comments
 (0)