Skip to content

Commit bf89a03

Browse files
committed
updated README.md
1 parent e420c77 commit bf89a03

1 file changed

Lines changed: 21 additions & 3 deletions

File tree

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
#### HttpStatusDogs - Spring starter that provides a perfect description for your server's responses
1+
# HttpStatusDogs
2+
### Spring starter that provides a perfect description for your server's responses
23

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

15-
##### Example
16+
### Usage
1617

18+
To start using HttpStatusDogs, just include the following dependency in your `build.gradle`
19+
```groovy
20+
implementation 'dev.fomenko:httpstatusdogs:1.0.0'
21+
```
22+
23+
or `pom.xml` file:
24+
```xml
25+
26+
<dependency>
27+
<groupId>dev.fomenko</groupId>
28+
<artifactId>httpstatusdogs</artifactId>
29+
<version>1.0.0</version>
30+
</dependency>
31+
```
32+
33+
### Example
34+
1735
```java
1836
@RestController
1937
class FakeController {
@@ -26,7 +44,7 @@ Link examples:
2644
```
2745
For the given RestController response will be:
2846

29-
```http request
47+
```http request
3048
HTTP/1.1 404
3149
StatusDog: https://httpstatusdogs.com/img/404.jpg
3250
Content-Type: text/plain;charset=UTF-8

0 commit comments

Comments
 (0)