mkuczera / react-native-haptic-feedback

React-Native Haptic Feedback for iOS with Android similar behaviour.
MIT License
855 stars 103 forks source link

šŸš€ Revamped Documentation: Clearer Instructions, Enhanced Formatting, and Improved Readability #110

Closed thenishantgiri closed 1 year ago

thenishantgiri commented 1 year ago

Pull Request Summary

This pull request enhances the documentation for the react-native-haptic-feedback library by restructuring and reformatting the content to improve readability, clarity, and organization. The changes include:

  1. Improved Markdown Formatting: The documentation has been reformatted using appropriate Markdown elements to create clear sections, headings, and bullet points, making it easier to follow and navigate.

  2. Enhanced Explanation: The installation and setup instructions for both iOS and Android have been expanded with detailed step-by-step guides, ensuring users can effortlessly integrate the library into their projects.

  3. Revised Linking Section: The linking instructions have been revised to include information about automatic linking in React Native 0.60 and above, reducing confusion and providing a more up-to-date approach.

  4. Updated Usage Guide: The usage guide for triggering haptic feedback has been revised and formatted for clarity. It now includes examples using both the default import and named import approaches.

  5. Method Overview Table: The table summarizing the available haptic feedback methods has been reformatted for better visual clarity, utilizing emojis to represent compatibility on Android and iOS.

  6. Improved Contribution Callout: The "Contributions Welcome" section has been updated to include a direct link to contributors, adding a dynamic and engaging touch to the documentation.

These changes enhance the overall user experience by providing a more organized, clear, and aesthetically pleasing documentation guide for using the react-native-haptic-feedback library.