Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zssz committed Feb 14, 2020
1 parent 3c81785 commit 3ea4e8c
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,27 @@

Berkanan SDK enables Bluetooth-powered mesh messaging between nearby apps. It's the framework used by [Berkanan](https://apps.apple.com/app/berkanan-messenger/id1289061820) ([Product Hunt](https://www.producthunt.com/posts/berkanan), [TechCrunch](https://techcrunch.com/2018/09/27/berkanan-is-a-bluetooth-powered-group-messaging-app/)) and [Berkanan Lite](https://apps.apple.com/app/berkanan-messenger-lite/id1479731429) ([GitHub](https://github.com/zssz/BerkananLite)).

With Berkanan SDK apps can discover nearby apps, which also have the SDK integrated, and send them small messages via Bluetooth. The range for messages is about 70 meters, but they can reach further because the SDK automatically resends them upon receiving. The more apps use Berkanan SDK, the bigger the network and further the reach of the messages gets.
With Berkanan SDK, apps can discover nearby apps, which also have the SDK integrated, and send them small messages via Bluetooth. The range is about 70 meters, but they can reach further because the SDK automatically resends them upon receiving. The more apps use Berkanan SDK, the further the reach of the messages gets.

### Features and Limitations
- Free and open-source: Contributions are welcome!
- Bluetooth-powered: No need for Wi-Fi or cellular connectivity.
- Background: On iOS it works even while the app is in the background.
- Connectionless communication with no pairing, no sessions and no limit on the number of apps.
- Messages are sent using [flooding](https://en.wikipedia.org/wiki/Flooding_(computer_networking)) where duplicates are filtered by tracking their identifiers and decreasing their time to live (TTL) by 1 until they reach 0, as they travel from app to app.
- Background: On iOS, it works even while in the background.
- Connectionless communication with no pairing, no sessions, and no limit on the number of apps.
- For sending messages, the SDK uses [flooding](https://en.wikipedia.org/wiki/Flooding_(computer_networking)), where duplicates are filtered by tracking their identifiers and decreasing their time to live (TTL) by 1, until they reach 0, as they travel from app to app.
- The message range limit between two devices is about 70 meters.
- The data size limit is 512 bytes.
- No built-in support for encryption, [acknowledgment](https://en.wikipedia.org/wiki/Acknowledgement_(data_networks)) or [store and forward](https://en.wikipedia.org/wiki/Store_and_forward); you have to roll your own if your use case requires it.
- Supported operating systems: iOS v9.0 or later, macOS v10.13 or later, watchOS v2.0 or later, tvOS v9.0 or later
- No built-in support for encryption, [acknowledgment](https://en.wikipedia.org/wiki/Acknowledgement_(data_networks)), or [store and forward](https://en.wikipedia.org/wiki/Store_and_forward). You have to roll your own if your use case requires it.
- Supported operating systems: iOS 9.0 or later, watchOS 4.0 or later, tvOS 9.0 or later, macOS 10.13 or later.

### Privacy Policy
Berkanan SDK does not send the messages to any central server or company — this can be verified by looking at its source code. If your app's messages contain sensitive information (e.g., a private text message) you should use encryption.
Berkanan SDK does not send the messages to any central server or company — this can be verified by looking at its source code. If your app's messages contain sensitive information (e.g., a private text message), you should use encryption.

## Integrating Berkanan SDK into Your App
## Integrating Berkanan SDK into your app

### iOS

To integrate Berkanan SDK into your iOS app, the easiest way is to use Xcode 11 or later. Open the .xcodeproj or .xcworkspace file of your app and follow these steps.
To integrate Berkanan SDK into your iOS app, use Xcode 11 or later. Open the .xcodeproj or .xcworkspace file of your app and follow these steps.

#### Configuring your app target

Expand Down Expand Up @@ -110,4 +110,4 @@ service.stop()

#### Sample app

To see how Berkanan SDK is integrated into [Berkanan Lite](https://apps.apple.com/app/berkanan-messenger-lite/id1479731429), check out its [source code](https://github.com/zssz/BerkananLite).
To see how [Berkanan Lite app](https://apps.apple.com/app/berkanan-messenger-lite/id1479731429) integrates Berkanan SDK, check out its [source code](https://github.com/zssz/BerkananLite).

0 comments on commit 3ea4e8c

Please sign in to comment.