Skip to content

Latest commit

 

History

History
147 lines (125 loc) · 10.6 KB

README.md

File metadata and controls

147 lines (125 loc) · 10.6 KB
Raw

Unit Tests SwiftLint Docs

Nostr SDK for Apple Platforms

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

Minimum Requirements

  • Swift 5.8
  • iOS 15
  • macOS 12

Spec Compliance

The following NIPs are implemented:

Installation

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

Releases follow semantic versioning.

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. Select Up to Next Major Version starting from the latest release as the dependency rule.
  5. Ensure your project is selected next to Add to Project.
  6. Click Add Package.
  7. On the package product dialog, add NostrSDK to your target and 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", .upToNextMajor(from: "0.2.0"))
    ],
    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.

Acknowledgements