/nostr-sdk-ios

Nostr SDK for Apple Platforms is a native Swift library that enables developers to quickly and easily build Nostr-based apps for Apple platforms.

Primary LanguageSwiftMIT LicenseMIT

Unit Tests SwiftLint Docs

Nostr SDK for Apple Platforms

Nostr SDK library for Apple Platforms.

Warning: The API is not currently stable and not guaranteed to be backwards compatible yet.

Minimum Requirements

  • Swift 5.7.1
  • iOS 15
  • macOS 12

Features

TBD

Spec Compliance

Nostr SDK iOS implements the following NIPs:

Installation

Nostr SDK can be integrated as an Xcode project target or a Swift package target.

Xcode Project Target

  1. Go to File -> Add Package Dependencies.
  2. Type https://github.com/nostr-sdk/nostr-sdk-ios.git into the search field.
  3. Select nostr-sdk-ios from the search results.
  4. Click Add Package.

Swift Package Target

In your Package.swift file:

  1. Add the NostrSDK package dependency to https://github.com/nostr-sdk/nostr-sdk-ios.git
  2. Add NostrSDK as a dependency on the targets that need to use the SDK.
let package = Package(
	// ...
    dependencies: [
        // ...
        .package(url: "https://github.com/nostr-sdk/nostr-sdk-ios.git", branch: "master")
    ],
    targets: [
        .target(
            // ...
            dependencies: ["NostrSDK"]
        ),
        .testTarget(
            // ...
            dependencies: ["NostrSDK"]
        )
    ]
)

Contributing

If you would like to contribute to this library, please see CONTRIBUTING.md.

Contact

These are the core maintainers of this library and their Nostr public keys.