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
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,35 @@ Kite Connect is a set of REST-like APIs that expose many capabilities required t
- [Java library documentation](https://kite.trade/docs/javakiteconnect/)

## Usage
Integrate the Kite Connect API Java client into your project using one of the following methods:

### Download jar file
- [Download Kite Connect 3 jar file](https://github.com/zerodhatech/javakiteconnect/tree/master/dist) and include it in your build path.

- Include com.zerodhatech.kiteconnect into build path from maven. Use version 3.4.0

- To use javakiteconnect in **Android**, you need to include jar file in the libs directory and add the following line in you module's gradle file ``` compile files('libs/kiteconnect.jar') ```

### Maven
Add the following dependency to your `pom.xml`:

```xml
<!-- https://mvnrepository.com/artifact/com.zerodhatech.kiteconnect/kiteconnect -->
<dependency>
<groupId>com.zerodhatech.kiteconnect</groupId>
<artifactId>kiteconnect</artifactId>
<version>3.4.0</version>
</dependency>
```

### Gradle
Add the following line to your build.gradle:

```xml
// https://mvnrepository.com/artifact/com.zerodhatech.kiteconnect/kiteconnect
implementation 'com.zerodhatech.kiteconnect:kiteconnect:3.4.0'
```

## API usage
```java
// Initialize Kiteconnect using apiKey.
Expand Down