diff --git a/README.md b/README.md index 3511f11..82e1715 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,21 @@
-# react-native-xenon :microscope: +# React Native Xenon -### A comprehensive tool for analyzing HTTP(S) requests and logs in React Native apps. +### A comprehensive tool for analyzing HTTP(S) requests and logs in React Native apps. :microscope:
-[![GitHub Actions Workflow Status][github-actions-status-badge]][github-actions-link] +[![GitHub Actions Workflow Status][github-actions-status-badge]][github-actions-status-link] [![NPM Version][npm-version-badge]][npm-version-link] [![React Native][react-native-badge]][react-native-link] -[![Runs With Expo][runs-with-expo-badge]][runs-with-expo-link] -[![Types Included][types-included-badge]][types-included-link] +[![Runs With Expo][expo-badge]][expo-link] +[![Types Included][typescript-badge]][typescript-link] +
+[![GitHub License][github-license-badge]][github-license-link] +[![NPM Downloads Per Month][npm-downloads-per-month-badge]][npm-downloads-per-month-link] [![Buy Me A Coffee][buy-me-a-coffee-badge]][buy-me-a-coffee-link]
@@ -31,7 +34,7 @@ ### React Native -Install the Xenon with `yarn` or `npm`. You will also need to install `react-native-safe-area-context` if you haven't already. +Install the Xenon with **yarn** or **npm**. You will also need to install `react-native-safe-area-context` if you haven't already. ```sh yarn add react-native-xenon react-native-safe-area-context @@ -98,11 +101,12 @@ Xenon.hide(); | `show()` | `void` | Makes the debugger visible. If it is already visible, this method has no additional effect. | | `hide() ` | `void` | Hides the debugger. If it is already hidden, this method has no additional effect. | -## Example Project +## Examples -To try out react-native-xenon, you can run the example project: +To try out Xenon, you can run the example project: ```sh +# Clone the repo git clone https://github.com/purrseus/react-native-xenon.git cd react-native-xenon @@ -113,6 +117,8 @@ yarn install yarn example start ``` +See the [example](./example) directory for more information. + ## Contributing See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow. @@ -124,14 +130,18 @@ This project is [MIT](./LICENSE) licensed. [github-actions-status-badge]: https://img.shields.io/github/actions/workflow/status/purrseus/react-native-xenon/ci.yml?style=for-the-badge&logo=github&label=%20&labelColor=1B1B1D -[github-actions-link]: https://github.com/purrseus/react-native-xenon/blob/develop/.github/workflows/ci.yml +[github-actions-status-link]: ./.github/workflows/ci.yml [npm-version-badge]: https://img.shields.io/npm/v/react-native-xenon?style=for-the-badge&color=CC3F3E&labelColor=1B1B1D&logo=npm&label=%20&logoColor=CC3F3E [npm-version-link]: https://www.npmjs.com/package/react-native-xenon -[react-native-badge]: https://img.shields.io/badge/%20react%20native-67DAFB?style=for-the-badge&logo=react&logoColor=67DAFB&labelColor=1B1B1D +[react-native-badge]: https://img.shields.io/badge/%20React%20Native-67DAFB?style=for-the-badge&logo=react&logoColor=67DAFB&labelColor=1B1B1D [react-native-link]: https://reactnative.dev -[runs-with-expo-badge]: https://img.shields.io/badge/runs%20with%20Expo-FFFFFF?style=for-the-badge&logo=expo&labelColor=1B1B1D&logoColor=FFFFFF -[runs-with-expo-link]: https://expo.dev -[types-included-badge]: https://img.shields.io/badge/included-3077C6?style=for-the-badge&logo=typescript&logoColor=3077C6&labelColor=1B1B1D -[types-included-link]: https://www.typescriptlang.org +[expo-badge]: https://img.shields.io/badge/Expo-FFFFFF?style=for-the-badge&logo=expo&labelColor=1B1B1D&logoColor=FFFFFF +[expo-link]: https://expo.dev +[typescript-badge]: https://img.shields.io/badge/TypeScript-3077C6?style=for-the-badge&logo=typescript&logoColor=3077C6&labelColor=1B1B1D +[typescript-link]: https://www.typescriptlang.org +[github-license-badge]: https://img.shields.io/badge/License-MIT-44CD11?style=for-the-badge&labelColor=1B1B1D +[github-license-link]: ./LICENSE +[npm-downloads-per-month-badge]: https://img.shields.io/npm/dm/react-native-xenon?style=for-the-badge&labelColor=1B1B1D +[npm-downloads-per-month-link]: https://www.npmjs.com/package/react-native-xenon [buy-me-a-coffee-badge]: https://img.shields.io/badge/%20-Buy%20me%20a%20coffee-FEDD03?style=for-the-badge&logo=buymeacoffee&labelColor=1B1B1D [buy-me-a-coffee-link]: https://www.buymeacoffee.com/thiendo261 diff --git a/package.json b/package.json index c8c012e..374ec8d 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "react-native-xenon", "version": "0.5.1", - "description": "A comprehensive tool for analyzing HTTP(S) requests and logs in React Native apps. Designed for use across all environments, it offers an intuitive interface for efficient debugging and issue resolution.", + "description": "A comprehensive tool for analyzing HTTP(S) requests and logs in React Native apps. 🔬", "source": "./src/index.ts", "main": "./lib/commonjs/index.js", "module": "./lib/module/index.js",