Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelfmnk committed May 14, 2022
1 parent e420c77 commit bf89a03
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#### HttpStatusDogs - Spring starter that provides a perfect description for your server's responses
# HttpStatusDogs
### Spring starter that provides a perfect description for your server's responses

---
[![Build Status](https://travis-ci.org/michaelfmnk/httpstatusdogs.svg?branch=master)](https://travis-ci.org/michaelfmnk/httpstatusdogs)
Expand All @@ -12,8 +13,25 @@ Link examples:
- https://httpstatusdogs.com/img/500.jpg
- etc.

##### Example
### Usage

To start using HttpStatusDogs, just include the following dependency in your `build.gradle`
```groovy
implementation 'dev.fomenko:httpstatusdogs:1.0.0'
```

or `pom.xml` file:
```xml

<dependency>
<groupId>dev.fomenko</groupId>
<artifactId>httpstatusdogs</artifactId>
<version>1.0.0</version>
</dependency>
```

### Example

```java
@RestController
class FakeController {
Expand All @@ -26,7 +44,7 @@ Link examples:
```
For the given RestController response will be:

```http request
```http request
HTTP/1.1 404
StatusDog: https://httpstatusdogs.com/img/404.jpg
Content-Type: text/plain;charset=UTF-8
Expand Down

0 comments on commit bf89a03

Please sign in to comment.