Skip to content

Commit cb41346

Browse files
committed
update README.md
1 parent 27a90b1 commit cb41346

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed
Binary file not shown.

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fdevyhan%2Fapirouter%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/devyhan/apirouter)
2-
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fdevyhan%2Fapirouter%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/devyhan/apirouter)
1+
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fdevyhan%2FAPIRouter%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/devyhan/APIRouter)
2+
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fdevyhan%2FAPIRouter%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/devyhan/APIRouter)
33

44
![main](https://github.com/devyhan/apirouter/actions/workflows/ci.yml/badge.svg?branch=main)
55
[![codecov](https://codecov.io/gh/devyhan/APIRouter/branch/main/graph/badge.svg?token=ZQNDOX2VDF)](https://codecov.io/gh/devyhan/APIRouter)
@@ -18,6 +18,21 @@ It also provides a way for developers to create custom endpoints DSL(Domain-Spec
1818
Additionally, it provides a way to track the status of each endpoint and to easily detect any changes or updates that have been made.
1919

2020
Similar to Swift Evolution's [Regex builder DSL](https://github.com/apple/swift-evolution/blob/main/proposals/0351-regex-builder.md), URL string literal and a more powerful pattern result builder to help make Swift URL string processing fast and easy and without mistakes. Ultimately, with ***APIRouter***, changes are easy to detect and useful for maintenance.
21+
22+
## Installation 📦
23+
- Using [Swift Package Manager](https://swift.org/package-manager)
24+
25+
```swift
26+
import PackageDescription
27+
28+
let package = Package(
29+
name: "SomeApp",
30+
dependencies: [
31+
.Package(url: "https://github.com/devyhan/APIRouter", majorVersion: "<LATEST_RELEASES_VERSION>"),
32+
]
33+
)
34+
```
35+
2136
## Configure APIRouter 📝
2237
### Implement APIs Namespace
2338
- To implement APIs namespace we create a new type that will house the domain and behavior of the APIs by conforming to `RouterProtocol`.

0 commit comments

Comments
 (0)