Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AlTavares/Ciao
Publish and discover services using Bonjour
https://github.com/AlTavares/Ciao
bonjour carthage cocoapods mdns swift xcode zeroconf
Last synced: 3 months ago
JSON representation
Publish and discover services using Bonjour
- Host: GitHub
- URL: https://github.com/AlTavares/Ciao
- Owner: AlTavares
- License: mit
- Created: 2017-10-10T14:20:52.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-15T20:59:21.000Z (4 months ago)
- Last Synced: 2024-08-06T19:38:01.358Z (3 months ago)
- Topics: bonjour, carthage, cocoapods, mdns, swift, xcode, zeroconf
- Language: Swift
- Homepage:
- Size: 87.9 KB
- Stars: 62
- Watchers: 3
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - Ciao - Publish and discover services using mDNS(Bonjour, Zeroconf). (Networking / Video)
- awesome-swift - Ciao - Publish and discover services using mDNS (Bonjour, Zeroconf). (Libs / Network)
- awesome-swift - Ciao - Publish and discover services using mDNS (Bonjour, Zeroconf). (Libs / Network)
- awesome-ios-star - Ciao - Publish and discover services using mDNS(Bonjour, Zeroconf). (Networking / Video)
- fucking-awesome-swift - Ciao - Publish and discover services using mDNS (Bonjour, Zeroconf). (Libs / Network)
- awesome-swift - Ciao - Publish and discover services using Bonjour ` 📝 2 years ago ` (Network [🔝](#readme))
README
## Ciao
# Join the Ciao Project as a Contributor!
🚀 **We're inviting open-source enthusiasts to contribute!** 🚀
Despite a pause in updates, [Ciao](https://github.com/AlTavares/Ciao) is operational and ready for enhancements. Your contributions can breathe new life into it!
**How You Can Help:**
- **Code Enhancements:** From minor tweaks to major features, all contributions are welcome.
- **Documentation Updates:** Help keep our documentation current and user-friendly.
- **Community Engagement:** Support users and enrich discussions.
Start by forking the repo, create your feature branch, and dive into our [issues](https://github.com/AlTavares/Ciao/issues). Every contribution is a step towards advancement!
[](https://cocoapods.org/pods/Ciao)
[](https://raw.githubusercontent.com/AlTavares/Ciao/master/LICENSE)
[](https://github.com/apple/swift-package-manager)
[](https://github.com/Carthage/Carthage)
[](https://cocoapods.org/pods/Ciao)
Lib to publish and find services using mDNS
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
## Requirements
- iOS 8.0+ / Mac OS X 10.10+ / tvOS 9.0+
- Xcode 9.0+
## Installation
### CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
```bash
$ gem install cocoapods
```
To integrate Ciao into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!
pod 'Ciao', '~> 2.1.1'
```
Then, run the following command:
```bash
$ pod install
```
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate Ciao into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl
github "AlTavares/Ciao" ~> 2.1.1
```
### Swift Package Manager
To use Ciao as a [Swift Package Manager](https://swift.org/package-manager/) package just add the following in your Package.swift file.
``` swift
dependencies: [
.package(url: "https://github.com/AlTavares/Ciao.git", from: "2.1.1")
]
```
## Usage
### Server
```swift
let ciaoServer = CiaoServer(type: ServiceType.tcp("ciaoserver"))
ciaoServer.start { (success) in
print("Server started:", success)
}
ciaoServer.txtRecord = ["someKey": "someValue"]
```
### Browser
```swift
let ciaoBrowser = CiaoBrowser()
// get notified when a service is found
browser.serviceFoundHandler = { service in
print("Service found")
print(service)
}
// register to automatically resolve a service
browser.serviceResolvedHandler = { service in
print("Service resolved")
print(service)
print(service.hostName)
print(service.txtRecordDictionary)
}
browser.serviceRemovedHandler = { service in
print("Service removed")
print(service)
}
ciaoBrowser.browse(type: type)
```
### Resolver
Optionally you can also use the resolver to any NetService instance
```swift
var resolver = CiaoResolver(service: service)
resolver?.resolve(withTimeout: 0) { (result: Result) in
print(result)
}
```
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## License
Ciao is released under the MIT license. See [LICENSE](https://github.com/AlTavares/Ciao/blob/master/LICENSE) for details.