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.

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

#44: Update README.md #45

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

#44: Update README.md #45

wants to merge 1 commit into from

Conversation

maulikam
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant