Skip to content

Commit 8eb8b5a

Browse files
authored
Merge pull request #1 from DevCycleHQ/docs-unification
Standardize doc format
2 parents 8a57809 + 7e8ce4f commit 8eb8b5a

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# DevCycle Java Server SDK
22

3+
Welcome to the DevCycle Java SDK, which interfaces with the [DevCycle Bucketing API](https://docs.devcycle.com/bucketing-api/#tag/devcycle).
4+
35
## Requirements
46

57
This version of the DevCycle SDK works with Java 8 and above.
68

79
Using the Java SDK library requires [Maven](https://maven.apache.org/) or [Gradle](https://gradle.org/) >= 5.6.4 to be installed.
810

9-
## Usage
11+
## Installation
1012

1113
### Maven
1214

@@ -33,7 +35,23 @@ The JVM, by default, caches DNS for infinity. DevCycle servers are load balanced
3335
setting the DNS cache TTL to a short duration is recommended. The TTL is controlled by this security setting `networkaddress.cache.ttl`.
3436
Recommended settings and how to configure them can be found [here](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-jvm-ttl.html).
3537

36-
## Author
37-
DevCycle
38+
## Getting Started
39+
40+
To use the DevCycle Java SDK, initialize a client object.
41+
42+
```java
43+
import com.devcycle.sdk.server.api.DVCClient;
3844

45+
public class MyClass {
46+
47+
private DVCClient dvcClient;
48+
49+
public MyClass() {
50+
dvcClient = new DVCClient("your_server_key");
51+
}
52+
}
53+
```
54+
55+
## Usage
3956

57+
**[Read more usage information here](https://github.com/DevCycleHQ/java-server-sdk/tree/main/docs)**

0 commit comments

Comments
 (0)