Giter Club home page Giter Club logo

underdark-cocoa's Introduction

Underdark iOS

http://underdark.io

Peer-to-peer networking library for iOS and Android, with Wi-Fi and Bluetooth support.

This repository contains library binaries, example app with sources and also short “Getting Started” guide below.

License

http://underdark.io/LICENSE.txt

Underdark is published under the Underdark License, which is modified Apache 2.0 license with added requirement that applications that use the library must add to their app store description the following line: “Mesh networking by http://underdark.io”

Demo apps

Video demo: http://www.youtube.com/watch?v=ox4dh0s1XTw

Author

You can contact me via Telegram at http://telegram.me/virlof or by email at [email protected]

Installation

  1. Download latest version: Download or previous version: https://bintray.com/underdark/ios/underdark/
  2. Unarchive downloaded .zip file into your project subdirectoy.
  3. Add all *.framework files/dirs from unarchive directory to “Embedded binaries” and “Linked Frameworks and Libraries” in your project target’s settings in Xcode.
  4. Add unarchived directory to "Framework Search Paths" in your Xcode Target's Build Settings.
  5. When using framework’s classes, import them with @import Underdark; in Objective-C or import Underdark in Swift.

Publishing your app to App Store

  1. Install Carthage https://github.com/Carthage/Carthage
  2. Add "Run Script" build phase to your app target's build phases with /usr/local/bin/carthage copy-frameworks code.
  3. As its input files list paths to all *.framework files in previously unarchived directory like that:
$(SRCROOT)/../underdark/Underdark.framework
$(SRCROOT)/../underdark/ProtocolBuffers.framework
  1. Place that Run Script build phase AFTER "Embed Frameworks" build phase.
  2. See more here: https://github.com/Carthage/Carthage#if-youre-building-for-ios-tvos-or-watchos

Getting started

Underdark API is very simple — it consists of entry class UDUnderdark with method configureTransport* — it allows you to create UDTransport instance with desired parameters (like network interface type) and specify UDTransportDelegate implementation for callbacks.

Full documentation resides in appledoc of Underdark.framework, starting from UDUnderdark class.

underdark-cocoa's People

Contributors

virl avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.