Skip to content

Commit 5914d8e

Browse files
authored
Update README.md
Updated README
1 parent 8e2e6fc commit 5914d8e

File tree

1 file changed

+45
-3
lines changed

1 file changed

+45
-3
lines changed

README.md

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,46 @@
1+
[![Build Status](https://travis-ci.com/IBM/java-sdk-core.svg?branch=master)](https://travis-ci.com/IBM/java-sdk-core)
2+
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.ibm.cloud/sdk-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.ibm.cloud/sdk-core)
3+
14
# java-sdk-core
2-
This project contains the core classes used by Java SDK's generated by the IBM OpenAPI 3 SDK Generator (openapi-sdkgen).
3-
Java code generated by openapi-sdkgen will depend on the classes contained in this project. Therefore, each Java SDK project
4-
will need to define a dependency on this project.
5+
This project contains the core classes used by Java SDK's generated by the IBM OpenAPI SDK Generator (openapi-sdkgen).
6+
Java code generated by openapi-sdkgen will depend on the classes contained in this project. Therefore, each Java SDK project will need to define a dependency on this project.
7+
8+
## Installation
9+
You can use this project by defining it as a dependency within your "Java SDK" project (i.e. a project containing java code generated by the IBM OpenAPI SDK generator).
10+
To find the correct version to specify in your dependency definitions, consult the `Releases` tab of this github repository. There you will find the published releases (versions) of the project.
11+
12+
##### Maven
13+
```xml
14+
<dependency>
15+
<groupId>com.ibm.cloud</groupId>
16+
<artifactId>sdk-core</artifactId>
17+
<version>1.1.0</version>
18+
</dependency>
19+
```
20+
21+
##### Gradle
22+
23+
```gradle
24+
'com.ibm.cloud:sdk-core:1.1.0'
25+
```
26+
# Issues
27+
28+
If you encounter an issue with this project, you are welcome to submit a [bug report](https://github.com/IBM/java-sdk-core/issues).
29+
Before opening a new issue, please search for similar issues. It's possible that someone has already reported it.
30+
31+
## Open source @ IBM
32+
33+
Find more open source projects on the [IBM Github Page](http://github.com/IBM)
34+
35+
## License
36+
37+
This library is licensed under Apache 2.0. Full license text is
38+
available in [LICENSE](LICENSE).
39+
40+
## Contributing
41+
42+
See [CONTRIBUTING.md](CONTRIBUTING.md).
43+
44+
## Code of conduct
45+
46+
See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).

0 commit comments

Comments
 (0)