Skip to content

Commit 4f1d4ab

Browse files
authored
Update readme (#13)
Adds a documentation publish success/failure badge and reorganizes the readme
1 parent 201ba12 commit 4f1d4ab

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# HTTPEngine
2-
![Swift](https://github.com/JZDesign/HTTPEngine/workflows/Swift/badge.svg) [![SPM compatible](https://img.shields.io/badge/SPM-Compatible-e66f20.svg?style=flat)](https://github.com/apple/swift-package-manager) [![Docs](https://img.shields.io/badge/Jazzy-Documentation-634fb3.svg?style=flat)](https://jzdesign.github.io/HTTPEngine/) [![License](https://img.shields.io/badge/License-MIT-335577.svg?style=flat)](https://github.com/JZDesign/HTTPEngine/blob/master/LICENSE)
2+
![Swift](https://github.com/JZDesign/HTTPEngine/workflows/Swift/badge.svg) ![PublishDocumentation](https://github.com/JZDesign/HTTPEngine/workflows/PublishDocumentation/badge.svg) [![Docs](https://img.shields.io/badge/Jazzy-Documentation-634fb3.svg?style=flat)](https://jzdesign.github.io/HTTPEngine/) [![SPM compatible](https://img.shields.io/badge/SPM-Compatible-e66f20.svg?style=flat)](https://github.com/apple/swift-package-manager) [![License](https://img.shields.io/badge/License-MIT-335577.svg?style=flat)](https://github.com/JZDesign/HTTPEngine/blob/master/LICENSE)
33

44
A convenience wrapper around Swift's Combine and URLSession to make `URLRequests`
55

@@ -10,10 +10,6 @@ dependencies: [
1010
],
1111
```
1212

13-
## [View Documentation](https://jzdesign.github.io/HTTPEngine/)
14-
15-
Documentation generated by [Jazzy](https://github.com/realm/jazzy).
16-
1713

1814
## Usage
1915
### Get and decode
@@ -72,5 +68,9 @@ engine
7268
.sink { data in
7369
// handle response data
7470
}
71+
```
72+
73+
74+
## [View Documentation](https://jzdesign.github.io/HTTPEngine/)
7575

76-
```
76+
Documentation generated by [Jazzy](https://github.com/realm/jazzy).

0 commit comments

Comments
 (0)