|
1 |
| -# DigitalOcean API Client [](https://travis-ci.org/jeevatkm/digitalocean-api-java) [](https://github.com/jeevatkm/digitalocean-api-java/releases/latest) [](LICENSE) |
| 1 | +<p align="center"> |
| 2 | + <h1 align="center">DigitalOcean API Client for Java</h1> |
| 3 | + <p align="center"><a href="https://travis-ci.org/jeevatkm/digitalocean-api-java"><img src="https://img.shields.io/travis/jeevatkm/digitalocean-api-java/master.svg?style=flat-square" alt="Build Status" /></a> <a href="https://github.com/jeevatkm/digitalocean-api-java/releases/latest"><img src="https://img.shields.io/badge/version-2.17-blue.svg?style=flat-square" alt="Version" /></a> <a href="https://docs.myjeeva.com/javadoc/digitalocean-api-client/2.17/" target="_blank"><img src="https://img.shields.io/badge/javadoc-reference-00bcd4.svg?style=flat-square" alt="Javadoc" /></a> <a href="LICENSE"><img src="https://img.shields.io/github/license/jeevatkm/digitalocean-api-java.svg?style=flat-square" alt="License" /></a> </p> |
| 4 | + <p align="center">Simple & Lightweight API client library for Enterprise Application or Utilities Integration around <a href="https://developers.digitalocean.com" target="_blank">DigitalOcean RESTful APIs</a>. You can use this library with project based (JVM hosted languages) on Java, Groovy, Scala, Clojure, etc.</p> |
| 5 | +</p> |
| 6 | +<p align="center"> |
| 7 | +Give your support by clicking Hearts on <a href="https://www.digitalocean.com/community/projects/api-client-in-java" target="_blank">DigitalOcean Developers Community</a>. |
| 8 | +</p> |
2 | 9 |
|
3 |
| -***v2.16 [released](https://github.com/jeevatkm/digitalocean-api-java/releases/latest) and tagged on Sep 03, 2018*** |
| 10 | +## News |
4 | 11 |
|
5 |
| -Simple & Lightweight API client library for Enterprise Application or Utilities Integration around [DigitalOcean RESTful APIs][1]. You can use this library with project based (JVM hosted languages) on Java, Groovy, Scala, Clojure, etc. |
| 12 | + * [v2.17](https://github.com/jeevatkm/digitalocean-api-java/releases/tag/v2.17) released and tagged on Feb 03, 2019 |
| 13 | + * [v2.16](https://github.com/jeevatkm/digitalocean-api-java/releases/tag/v2.16) released and tagged on Sep 03, 2018 |
| 14 | + * [v2.15](https://github.com/jeevatkm/digitalocean-api-java/releases/tag/v2.15) released and tagged on May 5, 2018 |
| 15 | + * [v2.14](https://github.com/jeevatkm/digitalocean-api-java/releases/tag/v2.14) released and tagged on Mar 6, 2018 |
| 16 | + * [v2.13](https://github.com/jeevatkm/digitalocean-api-java/releases/tag/v2.13) eleased and tagged on Nov 18, 2017 |
6 | 17 |
|
7 |
| -Give your support by clicking Hearts on [DigitalOcean Developers Community](https://www.digitalocean.com/community/projects/api-client-in-java) :) |
| 18 | +## Getting Started |
8 | 19 |
|
9 |
| -# Getting Started |
| 20 | +For handy use, DigitalOcean API Client library project dependency definition provided below or you wanna jar [Download it](http://search.maven.org/remotecontent?filepath=com/myjeeva/digitalocean/digitalocean-api-client/2.17/digitalocean-api-client-2.17.jar) from Maven central repo. |
10 | 21 |
|
11 |
| -For handy use, DigitalOcean API Client library project dependency definition provided below or you wanna jar [Download it][16] from Maven central repo. |
12 |
| - |
13 |
| -*Note: [master][11] branch maps to v2 APIs and digitalocean turned off [v1 APIs](https://developers.digitalocean.com/documentation/changelog/api-v1/sunsetting-api-v1/) as on Nov 9, 2015 .* |
| 22 | +*Note: [master](https://github.com/jeevatkm/digitalocean-api-java) branch maps to v2 APIs and digitalocean turned off [v1 APIs](https://developers.digitalocean.com/documentation/changelog/api-v1/sunsetting-api-v1/) as on Nov 9, 2015 .* |
14 | 23 |
|
15 | 24 | **Maven dependency**
|
16 | 25 | ```xml
|
17 | 26 | <dependency>
|
18 | 27 | <groupId>com.myjeeva.digitalocean</groupId>
|
19 | 28 | <artifactId>digitalocean-api-client</artifactId>
|
20 |
| - <version>2.16</version> |
| 29 | + <version>2.17</version> |
21 | 30 | </dependency>
|
22 | 31 | ```
|
23 | 32 | **Gradle/Grails dependency**
|
24 | 33 | ```shell
|
25 |
| -compile 'com.myjeeva.digitalocean:digitalocean-api-client:2.16' |
| 34 | +compile 'com.myjeeva.digitalocean:digitalocean-api-client:2.17' |
26 | 35 | ```
|
27 | 36 | **Groovy Grape**
|
28 | 37 | ```groovy
|
29 | 38 | @Grapes(
|
30 |
| -@Grab(group='com.myjeeva.digitalocean', module='digitalocean-api-client', version='2.16') |
| 39 | +@Grab(group='com.myjeeva.digitalocean', module='digitalocean-api-client', version='2.17') |
31 | 40 | )
|
32 | 41 | ```
|
33 | 42 | **Scala SBT**
|
34 | 43 | ```shell
|
35 |
| -libraryDependencies += "com.myjeeva.digitalocean" % "digitalocean-api-client" % "2.16" |
| 44 | +libraryDependencies += "com.myjeeva.digitalocean" % "digitalocean-api-client" % "2.17" |
36 | 45 | ```
|
37 | 46 |
|
38 |
| -**Note:** For Android projects, kindly include the `httpclient-android` library explicitly in your project dependencies. |
| 47 | +**Note:** |
| 48 | + |
| 49 | + * For Android projects, kindly include the `httpclient-android` library explicitly in your project dependencies. |
| 50 | + * Library `vx.x-SNAPSHOT` is [available](https://oss.sonatype.org/content/repositories/snapshots/com/myjeeva/digitalocean/digitalocean-api-client/) between the release version. Snapshot is update to with `master` branch. |
39 | 51 |
|
40 | 52 | * * *
|
41 | 53 |
|
42 |
| -# Getting Help |
| 54 | +## Getting Help |
43 | 55 |
|
44 | 56 | For API documentation see:
|
45 | 57 |
|
46 |
| -* [DigitalOcean API Client in Java][2] |
| 58 | +* [DigitalOcean API Client in Java](https://docs.myjeeva.com/javadoc/digitalocean-api-client/2.17/) |
47 | 59 |
|
48 | 60 | For Example usage see:
|
49 | 61 |
|
50 |
| -* Have a look at [DigitalOceanIntegrationTest][7] |
| 62 | +* Have a look at [DigitalOceanIntegrationTest](https://github.com/jeevatkm/digitalocean-api-java/blob/master/src/test/java/com/myjeeva/digitalocean/DigitalOceanIntegrationTest.java) |
51 | 63 |
|
52 |
| -# Samples |
| 64 | +## Samples |
53 | 65 |
|
54 | 66 | **Creating a DigitalOcean Client in three simple ways!**
|
55 | 67 | ```java
|
@@ -127,49 +139,31 @@ Droplet droplet = getDropletInfo(10000001);
|
127 | 139 | RateLimit rateLimit = droplet.getRateLimit();
|
128 | 140 | ```
|
129 | 141 |
|
130 |
| -# Reporting Issues |
| 142 | +## Reporting Issues |
131 | 143 |
|
132 |
| -DigitalOcean API Client uses [GitHub’s integrated issue tracking system][3] to record bugs and feature requests. If you want to raise an issue, please follow the recommendations bellow: |
| 144 | +DigitalOcean API Client uses [GitHub’s integrated issue tracking system](https://github.com/jeevatkm/digitalocean-api-java/issues) to record bugs and feature requests. If you want to raise an issue, please follow the recommendations bellow: |
133 | 145 |
|
134 | 146 | * Before you log a bug, please search the issue tracker to see if someone has already reported the problem. If the issue doesn’t already exist, create a new issue.
|
135 | 147 | * Please provide as much information as possible with the issue report, we like to know the version of DigitalOcean API Client that you are using.
|
136 | 148 | * If you need to paste code, or include a stack trace use Markdown ``` escapes before and after your text.
|
137 | 149 |
|
138 |
| -# Supported API's and Changelogs |
| 150 | +## Supported API's and Changelogs |
139 | 151 |
|
140 | 152 | Refer to [CHANGELOG.md](CHANGELOG.md)
|
141 | 153 |
|
142 |
| -# Author |
| 154 | +## Author |
143 | 155 |
|
144 | 156 | Jeevanandam M. - jeeva@myjeeva.com
|
145 | 157 |
|
146 |
| -# Contributing |
| 158 | +## Contributing |
147 | 159 |
|
148 | 160 | 1. Fork it
|
149 | 161 | 2. Create your feature branch - `git checkout -b my-new-feature`
|
150 |
| -3. Implement your changes and apply [Google Java Code Formatter][13] |
| 162 | +3. Implement your changes and apply [Google Java Code Formatter](https://raw.githubusercontent.com/darcyliu/google-styleguide/master/eclipse-java-google-style.xml) |
151 | 163 | 4. Commit your changes - `git commit -am 'Added feature'`
|
152 | 164 | 5. Push to the branch - `git push origin my-new-feature`
|
153 | 165 | 6. Create new Pull Request
|
154 | 166 |
|
155 |
| -# License |
156 |
| - |
157 |
| -DigitalOcean API Client - [MIT License][6]. |
158 |
| - |
159 |
| - |
160 |
| -[1]: https://developers.digitalocean.com |
161 |
| -[2]: https://docs.myjeeva.com/javadoc/digitalocean-api-client/2.16/ |
162 |
| -[3]: https://github.com/jeevatkm/digitalocean-api-java/issues |
163 |
| -[4]: https://oss.sonatype.org/content/repositories/snapshots/com/myjeeva/digitalocean/digitalocean-api-client/ |
164 |
| -[5]: https://myjeeva.com |
165 |
| -[6]: https://github.com/jeevatkm/digitalocean-api-java/blob/master/LICENSE |
166 |
| -[7]: https://github.com/jeevatkm/digitalocean-api-java/blob/master/src/test/java/com/myjeeva/digitalocean/DigitalOceanIntegrationTest.java |
167 |
| -[8]: http://search.maven.org/remotecontent?filepath=com/myjeeva/digitalocean/digitalocean-api-client/1.5/digitalocean-api-client-1.5.jar |
168 |
| -[9]: https://github.com/jeevatkm/digitalocean-api-java/blob/master/src/test/java/com/myjeeva/digitalocean/DigitalOceanMockTest.java |
169 |
| -[10]: http://docs.myjeeva.com/javadoc/digitalocean-api-client/2.4-SNAPSHOT/com/myjeeva/digitalocean/DigitalOcean.html |
170 |
| -[11]: https://github.com/jeevatkm/digitalocean-api-java |
171 |
| -[12]: https://github.com/jeevatkm/digitalocean-api-java/tree/api-v1 |
172 |
| -[13]: https://raw.githubusercontent.com/darcyliu/google-styleguide/master/eclipse-java-google-style.xml |
173 |
| -[14]: https://developers.digitalocean.com/documentation/changelog/api-v2/add-status-to-account/ |
174 |
| -[15]: https://developers.digitalocean.com/documentation/changelog/api-v2/deprecate-final-snaphots/ |
175 |
| -[16]: http://search.maven.org/remotecontent?filepath=com/myjeeva/digitalocean/digitalocean-api-client/2.16/digitalocean-api-client-2.16.jar |
| 167 | +## License |
| 168 | + |
| 169 | +DigitalOcean API Client - [MIT License](LICENSE). |
0 commit comments