javakiteconnect icon indicating copy to clipboard operation
javakiteconnect copied to clipboard

#44: Update README.md

Open maulikam opened this issue 10 months ago • 0 comments

Summary

This PR addresses the limitation of the current README file for the Kite Connect Java library, which only suggests downloading the JAR file directly. To facilitate better project management and modern development practices, we are enhancing the documentation to include dependency management through Maven and Gradle.

Changes

  • Maven: Provided detailed instructions and an example snippet for integrating the Kite Connect library using Maven. This snippet can be added to the pom.xml of the user's project.
  • Gradle: Included instructions and an example snippet for adding the Kite Connect library as a dependency in a Gradle project, which users can add to their build.gradle file.

Testing

  • Validated the Maven and Gradle snippets by integrating them into sample Java and Android projects to ensure they work as expected.
  • Reviewed the updated README for clarity, accuracy, and completeness in providing the necessary instructions for using Maven and Gradle.

Objective

The aim of these changes is to streamline the setup process for developers, enabling them to integrate the Kite Connect Java library into their projects more efficiently using the widely adopted dependency management tools Maven and Gradle.

maulikam avatar Mar 30 '24 13:03 maulikam