Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: nicer readme #198

Merged
merged 1 commit into from
Jun 22, 2023
Merged

docs: nicer readme #198

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

This package will help you render buttons in the navigation bar and handle the styling so you don't have to. It mimics the appearance of native navbar buttons and offers a simple and flexible interface for you to interact with.

- DRY library api
- Works great with icons from `@expo/vector-icons` / `react-native-vector-icons` or any other icon library
- Supports both [JS](https://reactnavigation.org/docs/stack-navigator) and [native](https://reactnavigation.org/docs/native-stack-navigator/) stack
- Beautiful overflow menus for items that don't fit into the navbar
- [Recipes](#recipes) and examples included
- Written in TS
✅ DRY library api
✅ Works great with icons from `@expo/vector-icons` / `react-native-vector-icons` or any other icon library
✅ Supports both [JS](https://reactnavigation.org/docs/stack-navigator) and [native](https://reactnavigation.org/docs/native-stack-navigator/) stack
✅ Beautiful overflow menus for items that don't fit into the navbar
✅ [Recipes](#recipes) and examples included
✅ Written in TS

#### Demo App

Expand Down Expand Up @@ -317,3 +317,4 @@ Colors for Android ripple effect, text and icons come from [React Navigation's t
- item margins need to be reviewed and polished; don't hesitate to contribute - [this](https://github.com/infinitered/reactotron/blob/master/docs/plugin-overlay.md) should help
- RTL is not tested
- web support is experimental
- ripple may look different on the header buttons vs on the back button if your version of react navigation does not have [this PR](https://github.com/react-navigation/react-navigation/pull/11386).