Skip to content
This repository has been archived by the owner on May 2, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
x-0o0 authored Apr 14, 2023
1 parent b0d5cb6 commit 8fae4b0
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,23 @@
# Satellite
The API communication module for Swift
![Frame 7@3x](https://user-images.githubusercontent.com/53814741/231978905-e0540fc8-1ea9-4beb-b088-357778092e66.png)

The Satellite is an API communication module written in Swift.

## v1: Sputnik

### Setting up with API key and your domain
```swift
Satellite.setup(key: "{API.KEY}", domain: "{BASE.URL}")
```

### Sending the request and receiving the response (Combine/Publisher)
```swift
Satellite
.send(request)
.receive(on: responsePublisher)
.resume()
```

### Sending the request and waiting the response (Async await)
```swift
let response = try await Satellite.response(from: request)
```

0 comments on commit 8fae4b0

Please sign in to comment.