From c57c8f20846599f69a1e7e1269734e2bc6385add Mon Sep 17 00:00:00 2001
From: Christoph Hagen <christoph@spacemasters.eu>
Date: Tue, 7 Jun 2022 17:03:22 +0200
Subject: [PATCH] Add short description

---
 README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3c57aaf..48f7996 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,19 @@
 # Push-API
 
-A description of this package.
+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.
+
+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: [
+    .package(url: "https://christophhagen.de/git/ch/Push-API.git", from: "0.4.0"),
+],
+```
+
+Then import the module in your code:
+```swift
+import PushAPI
+```