Push-Definitions/README.md

20 lines
792 B
Markdown
Raw Normal View History

2022-06-04 22:13:14 +02:00
# Push-API
2022-06-09 11:48:00 +02:00
This package contains message definitions, routes and information specifying the interface to a [Push-Server](https://christophhagen.de/git/ch/Push-Server.git). The package is used to implement both the client and the server using common definitions to ensure compatibility.
2022-06-07 17:03:22 +02:00
The package depends on [APNSwift](https://github.com/swift-server-community/APNSwift.git), which provides the definitions for push message contents and is used by the server to connect to the Apple Push Notification Service (APNs).
## Usage
Add the package dependency in your `Package.swift` file:
```swift
dependencies: [
2022-06-09 11:48:00 +02:00
.package(url: "https://christophhagen.de/git/ch/Push-Definitions.git", from: "1.0.0"),
2022-06-07 17:03:22 +02:00
],
```
Then import the module in your code:
```swift
2022-06-09 11:48:00 +02:00
import PushMessageDefinitions
2022-06-07 17:03:22 +02:00
```