Skip to content

Commit 15c30bd

Browse files
added some images to the readme
1 parent 639fd63 commit 15c30bd

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -629,6 +629,45 @@ sequenceDiagram
629629
- Larger models provide better quality but require more VRAM
630630
- The app continues working offline after initial model download
631631

632+
## App Naming and Rebranding
633+
634+
To customize the app name and branding for your own deployment, you'll need to update several configuration files:
635+
636+
### Primary Configuration
637+
**`src/app.config.json` (Line 2)** - Main app title source
638+
```json
639+
{
640+
"title": "Your App Name",
641+
"description": "Your app description"
642+
}
643+
```
644+
645+
### Additional Files to Update
646+
647+
1. **Mobile App Configuration** - `capacitor.config.ts` (Line 5)
648+
```typescript
649+
appName: 'Your App Name',
650+
```
651+
652+
2. **Progressive Web App Manifest** - `static/manifest.json` (Lines 2-3)
653+
```json
654+
{
655+
"name": "Your App Name",
656+
"short_name": "Your App Name",
657+
"description": "Your app description"
658+
}
659+
```
660+
661+
3. **Package Configuration** - `package.json` (Line 2)
662+
```json
663+
"name": "your-app-name"
664+
```
665+
666+
### Notes
667+
- The primary `src/app.config.json` configuration automatically updates most UI references through the `{appConfig.title}` system
668+
- Components that display the app name (ChatInterface, WelcomeGuide, MobileLayout) will automatically use the updated title
669+
- Remember to also update any documentation, README files, and deployment configurations with your new app name
670+
632671
## License
633672

634673
MIT License - feel free to use this project as a starting point for your own applications.

0 commit comments

Comments
 (0)