Skip to content

Add Real-World Example section to README#537

Merged
jakmro merged 4 commits intomainfrom
jakmro-patch-1
Aug 27, 2025
Merged

Add Real-World Example section to README#537
jakmro merged 4 commits intomainfrom
jakmro-patch-1

Conversation

@jakmro
Copy link
Copy Markdown
Contributor

@jakmro jakmro commented Aug 26, 2025

Description

Add Real-World Example section to README

Introduces a breaking change?

  • Yes
  • No

Type of change

  • Bug fix (change which fixes an issue)
  • New feature (change which adds functionality)
  • Documentation update (improves or adds clarity to existing documentation)
  • Other (chores, tests, code style improvements etc.)

Checklist

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly
  • My changes generate no new warnings

@jakmro jakmro requested review from chmjkb and darthez August 26, 2025 06:49
@msluszniak
Copy link
Copy Markdown
Member

msluszniak commented Aug 26, 2025

I would:

  • Move Documentation section above Real-world example, Documentation is very short section so it wouldn't "drag down" Real-word example much, move Ready-made models below Quickstart and Examples so these three: Real-world examples, Quickstart, and Examples would be the consecutive sections, making it consistent.
  • Rename Examples to Demo apps. When you will add section Real-world example name Examples will be kinda strange.

Copy link
Copy Markdown
Collaborator

@chmjkb chmjkb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm to me overall but I agree with what @msluszniak said

Copy link
Copy Markdown
Member

@msluszniak msluszniak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect, and the new image is also way better ;)

Copy link
Copy Markdown
Contributor

@NorbertKlockiewicz NorbertKlockiewicz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Graphic design is my passion

@jakmro jakmro merged commit 4344c09 into main Aug 27, 2025
2 checks passed
@jakmro jakmro deleted the jakmro-patch-1 branch August 27, 2025 09:09
KnextKoder pushed a commit to Synkhiv/react-native-executorch that referenced this pull request Nov 7, 2025
## Description

Add Real-World Example section to README

### Introduces a breaking change?

- [ ] Yes
- [x] No

### Type of change

- [ ] Bug fix (change which fixes an issue)
- [ ] New feature (change which adds functionality)
- [ ] Documentation update (improves or adds clarity to existing
documentation)
- [x] Other (chores, tests, code style improvements etc.)

### Checklist

- [x] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have updated the documentation accordingly
- [x] My changes generate no new warnings
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants