From db9138a12764902880eef1c0022190878ea45b36 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Kwa=C5=9Bniewski?= Date: Thu, 28 Nov 2024 10:13:39 +0100 Subject: [PATCH] feat: add README to packages (#167) --- packages/react-native-bottom-tabs/README.md | 34 +++++++++++++++++++++ packages/react-navigation/README.md | 5 +++ 2 files changed, 39 insertions(+) create mode 100644 packages/react-native-bottom-tabs/README.md create mode 100644 packages/react-navigation/README.md diff --git a/packages/react-native-bottom-tabs/README.md b/packages/react-native-bottom-tabs/README.md new file mode 100644 index 0000000..10d492b --- /dev/null +++ b/packages/react-native-bottom-tabs/README.md @@ -0,0 +1,34 @@ +

+ React Native Bottom Tabs +

+ +

+ Bottom Tabs that use native platform primitives.
+

+ +
+ +[![mit licence](https://img.shields.io/dub/l/vibe-d.svg?style=for-the-badge)](https://github.com/okwasniewski/react-native-bottom-tabs/blob/main/LICENSE) +[![npm version](https://img.shields.io/npm/v/react-native-bottom-tabs?style=for-the-badge)](https://www.npmjs.org/package/react-native-bottom-tabs) +[![npm downloads](https://img.shields.io/npm/dt/react-native-bottom-tabs.svg?style=for-the-badge)](https://www.npmjs.org/package/react-native-bottom-tabs) +[![npm downloads](https://img.shields.io/npm/dm/react-native-bottom-tabs.svg?style=for-the-badge)](https://www.npmjs.org/package/react-native-bottom-tabs) + +
+ +https://github.com/user-attachments/assets/fbdd9ce2-f4b9-4d0c-bd91-2e62bb422d69 + +## Documentation + +The full documentation can be found on our [website](https://okwasniewski.github.io/react-native-bottom-tabs/). + +## Contributing + +See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow. + +## License + +MIT + +--- + +Made with ❤️ and [create-react-native-library](https://github.com/callstack/react-native-builder-bob) diff --git a/packages/react-navigation/README.md b/packages/react-navigation/README.md new file mode 100644 index 0000000..786fc19 --- /dev/null +++ b/packages/react-navigation/README.md @@ -0,0 +1,5 @@ +# `@bottom-tabs/react-navigation` + +React Navigation integration for `react-native-bottom-tabs`. + +Installation instructions and documentation can be found on the [React Native Bottom Tabs website](https://okwasniewski.github.io/react-native-bottom-tabs/).