Skip to content

Commit

Permalink
adding logos
Browse files Browse the repository at this point in the history
  • Loading branch information
leogdion committed Aug 27, 2024
1 parent d2caf71 commit 5615245
Show file tree
Hide file tree
Showing 7 changed files with 46 additions and 8 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# SublimationBonjour
<p align="center">
<img alt="Sublimation" title="Sublimation" src="Sources/SublimationBonjour/Documentation.docc/Resources/SublimationBonjour.svg" height="200">
</p>
<h1 align="center"> SublimationBonjour </h1>

Use Bonjour for automatic discovery of your Swift Server.

Expand All @@ -12,9 +15,7 @@ Use Bonjour for automatic discovery of your Swift Server.
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fbrightdigit%2FSublimationBonjour%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/brightdigit/SublimationBonjour)


<!--
[![Codecov](https://img.shields.io/codecov/c/github/brightdigit/SublimationBonjour)](https://codecov.io/gh/brightdigit/SublimationBonjour)
-->
[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/brightdigit/SublimationBonjour)](https://www.codefactor.io/repository/github/brightdigit/SublimationBonjour)
[![codebeat badge](https://codebeat.co/badges/91d512f0-ab30-42f9-9791-02add3278171)](https://codebeat.co/projects/github-com-brightdigit-SublimationBonjour-main)
[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/brightdigit/SublimationBonjour)](https://codeclimate.com/github/brightdigit/SublimationBonjour)
Expand Down
12 changes: 8 additions & 4 deletions Sources/SublimationBonjour/Documentation.docc/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@

Use Bonjour for automatic discovery of your Swift Server.

![SublimationBonjour Diagram](SublimationBonjour.svg)

## Overview

When the Swift Server begins it will tell Sublimation the ip addresses or host names which are available to access the server from (including the port number and whether to use https or http). This is called a ``BonjourSublimatory``. The ``BonjourSublimatory`` then uses `NWListener` to advertise this information both by send the data encoded using Protocol Buffers as well as inside the Text Record advertised.
![SublimationBonjour Logo](SublimationBonjour.svg)

When the Swift Server begins it will tell Sublimation the ip addresses or host names which are available to access the server from (including the port number and whether to use https or http). This is called a ``BonjourSublimatory``.

![SublimationBonjour Diagram](SublimationBonjour-Diagram.svg)

The ``BonjourSublimatory`` then uses `NWListener` to advertise this information both by send the data encoded using Protocol Buffers as well as inside the Text Record advertised.

The iPhone or Apple Watch then uses a ``BonjourClient`` to fetch either an `AsyncStream` of `URL` via ``BonjourClient/urls`` or simply get the ``BonjourClient/first()` one available.
The iPhone or Apple Watch then uses a ``BonjourClient`` to fetch either an `AsyncStream` of `URL` via ``BonjourClient/urls`` or simply get the ``BonjourClient/first()`` one available.

### Setting up your Server

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5615245

Please sign in to comment.