Skip to content

Commit c67be98

Browse files
committed
Add README
1 parent 3795437 commit c67be98

File tree

3 files changed

+71
-4
lines changed

3 files changed

+71
-4
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
44

55
## 0.1.0 Initial Release
66

7-
Initial release. Should not be considered stable.
7+
Initial release.

README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Http-Client-Wrapper Java REST Client Abstraction Library
2+
3+
## What is it?
4+
5+
A collection of common patterns to build REST Client libraries on top of. It attempts to provide an abstracted
6+
interface for building REST clients. Included is an implementation of interfaces using HttpComponents.
7+
8+
## How to use this library
9+
10+
This client library is released on Maven Central. Add a new dependency to your project's POM file:
11+
12+
```xml
13+
<dependency>
14+
<groupId>org.sourcelab</groupId>
15+
<artifactId>http-client-wrapper</artifactId>
16+
<version>0.1.0</version>
17+
</dependency>
18+
```
19+
20+
# Contributing
21+
22+
Found a bug? Think you've got an awesome feature you want to add? We welcome contributions!
23+
24+
25+
## Submitting a Contribution
26+
27+
1. Search for an existing issue. If none exists, create a new issue so that other contributors can keep track of what you are trying to add/fix and offer suggestions (or let you know if there is already an effort in progress). Be sure to clearly state the problem you are trying to solve and an explanation of why you want to use the strategy you're proposing to solve it.
28+
1. Fork this repository on GitHub and create a branch for your feature.
29+
1. Clone your fork and branch to your local machine.
30+
1. Commit changes to your branch.
31+
1. Push your work up to GitHub.
32+
1. Submit a pull request so that we can review your changes.
33+
34+
*Make sure that you rebase your branch off of master before opening a new pull request. We might also ask you to rebase it if master changes after you open your pull request.*
35+
36+
## Acceptance Criteria
37+
38+
We love contributions, but it's important that your pull request adhere to some of the standards we maintain in this repository.
39+
40+
- All tests must be passing!
41+
- All code changes require tests!
42+
- All code changes must be consistent with our checkstyle rules.
43+
- Great inline comments.
44+
45+
# Other Notes
46+
47+
48+
## Releasing
49+
50+
Steps for proper release:
51+
- Update release version: `mvn versions:set -DnewVersion=X.Y.Z`
52+
- Validate and then commit version: `mvn versions:commit`
53+
- Update CHANGELOG and README files.
54+
- Merge to master.
55+
- Deploy to Maven Central: `mvn clean deploy -P release`
56+
- Create release on Github project.
57+
58+
59+
## Changelog
60+
61+
The format is based on [Keep a Changelog](http://keepachangelog.com/)
62+
and this project adheres to [Semantic Versioning](http://semver.org/).
63+
64+
[View Changelog](CHANGELOG.md)
65+
66+
67+

pom.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
<modelVersion>4.0.0</modelVersion>
66

77
<groupId>org.sourcelab.http</groupId>
8-
<artifactId>HttpClientWrapper</artifactId>
9-
<version>0.1.0-SNAPSHOT</version>
8+
<artifactId>http-client-wrapper</artifactId>
9+
<version>0.1.0</version>
1010
<packaging>jar</packaging>
1111

1212
<!-- Require Maven 3.3.9 -->
@@ -16,7 +16,7 @@
1616

1717
<!-- Module Description and Ownership -->
1818
<name>Http Client Wrapper</name>
19-
<description>A collection of abstracted http rest client libraries.</description>
19+
<description>A library to abstract common patterns for building http rest clients.</description>
2020
<url>https://github.com/SourceLabOrg/http-client-wrapper</url>
2121
<developers>
2222
<developer>

0 commit comments

Comments
 (0)