Skip to content

Improve phrasing and styling in some sections of README.md#469

Merged
jakmro merged 10 commits intosoftware-mansion:mainfrom
msluszniak:patch-2
Aug 6, 2025
Merged

Improve phrasing and styling in some sections of README.md#469
jakmro merged 10 commits intosoftware-mansion:mainfrom
msluszniak:patch-2

Conversation

@msluszniak
Copy link
Copy Markdown
Member

@msluszniak msluszniak commented Jul 25, 2025

Description

This PR adds minor styling fixes, corrects RN version and rephrases a few sections.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (improves or adds clarity to existing documentation)

Tested on

  • iOS
  • Android

Testing instructions

Screenshots

Related issues

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

Additional notes

The goal of this PR is to rephrase longer text sections into shorter ones without changing the original meaning, to improve the order of provided information, and to make minor improvements.
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@msluszniak msluszniak requested a review from chmjkb August 5, 2025 06:48
@msluszniak
Copy link
Copy Markdown
Member Author

One thing left, if we merged to the main a simplified syntax with useLLM etc. don't we want to update the example in the readme as well? @chmjkb

@chmjkb
Copy link
Copy Markdown
Collaborator

chmjkb commented Aug 5, 2025

@msluszniak yes we do, nice catch!

@msluszniak msluszniak requested a review from chmjkb August 5, 2025 11:53
@jakmro jakmro merged commit b818f8a into software-mansion:main Aug 6, 2025
2 checks passed
mkopcins pushed a commit that referenced this pull request Oct 15, 2025
## Description

This PR adds minor styling fixes, corrects RN version and rephrases a
few sections.

### Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [x] Documentation update (improves or adds clarity to existing
documentation)

### Tested on

- [ ] iOS
- [ ] Android

### Testing instructions

<!-- Provide step-by-step instructions on how to test your changes.
Include setup details if necessary. -->

### Screenshots

<!-- Add screenshots here, if applicable -->

### Related issues

<!-- Link related issues here using #issue-number -->

### Checklist

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

### Additional notes

<!-- Include any additional information, assumptions, or context that
reviewers might need to understand this PR. -->
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.

3 participants