From 892de190ad2bdd51786af3d27525c6bb2f765383 Mon Sep 17 00:00:00 2001 From: Terry Yiu <963907+tyiu@users.noreply.github.com> Date: Fri, 5 Apr 2024 09:13:18 -0400 Subject: [PATCH] Update readme and contributing guides --- CONTRIBUTING.md | 8 ++++++-- README.md | 26 ++++++++++++++++++-------- 2 files changed, 24 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3c10c28..bc40ae3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,10 @@ -# Nostr SDK iOS Contributing Guide +# Contributing Guide -Thank you for your interest in contributing to this Nostr SDK iOS library. We are currently not accepting external contributions (beyond core maintainers) at this time as we are in the early stages of bootstrapping the library. However, contributions will open up in the future, with the end goal of building a vibrant developer community. +Thank you for your interest in contributing to Nostr SDK for Apple Platforms. + +If you would like to contribute code, please [fork](https://github.com/nostr-sdk/nostr-sdk-ios/fork) the repository on GitHub, apply your changes on your fork, and open a [pull request](https://github.com/nostr-sdk/nostr-sdk-ios/compare). Please ensure that the [core principles](#core-principles) are followed. + +If you would like to report an issue, please file an [issue](https://github.com/nostr-sdk/nostr-sdk-ios/issues/new) in GitHub. ## Core Principles diff --git a/README.md b/README.md index 7451d5b..f4b3c7d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # Nostr SDK for Apple Platforms -[Nostr](https://github.com/nostr-protocol/nostr) SDK library for Apple Platforms. +Nostr SDK for Apple Platforms is a native Swift library that enables developers to quickly and easily build [Nostr](https://github.com/nostr-protocol/nostr)-based apps for Apple platforms. ## Minimum Requirements @@ -10,13 +10,9 @@ - iOS 15 - macOS 12 -## Features - -TBD - ## Spec Compliance -Nostr SDK iOS implements the following NIPs: +The following [NIPs](https://github.com/nostr-protocol/nips) are implemented: - [x] [NIP-01: Basic protocol flow description](https://github.com/nostr-protocol/nips/blob/master/01.md) - [x] [NIP-02: Follow List](https://github.com/nostr-protocol/nips/blob/master/02.md) @@ -82,12 +78,17 @@ Nostr SDK iOS implements the following NIPs: Nostr SDK can be integrated as an Xcode project target or a Swift package target. +[Releases](https://github.com/nostr-sdk/nostr-sdk-ios/releases) follow [semantic versioning](https://semver.org/). + ### 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`. +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 @@ -100,7 +101,7 @@ let package = Package( // ... dependencies: [ // ... - .package(url: "https://github.com/nostr-sdk/nostr-sdk-ios.git", branch: "master") + .package(url: "https://github.com/nostr-sdk/nostr-sdk-ios.git", .upToNextMajor(from: "0.1.0")) ], targets: [ .target( @@ -126,3 +127,12 @@ These are the core maintainers of this library and their Nostr public keys. - [Bryan Montz](https://github.com/bryanmontz) ([npub1qlk0nqupxmlyxravg0aqscxmcc4q4tq898z6x003rykwwh3npj0syvyayc](https://njump.me/npub1qlk0nqupxmlyxravg0aqscxmcc4q4tq898z6x003rykwwh3npj0syvyayc)) - [Joel Klabo](https://github.com/joelklabo) ([npub19a86gzxctwtz68l8zld2u9y2fjvyyj4juyx8m5geylssrmfj27eqs22ckt](https://njump.me/npub19a86gzxctwtz68l8zld2u9y2fjvyyj4juyx8m5geylssrmfj27eqs22ckt)) - [Terry Yiu](https://github.com/tyiu) ([npub1yaul8k059377u9lsu67de7y637w4jtgeuwcmh5n7788l6xnlnrgs3tvjmf](https://njump.me/npub1yaul8k059377u9lsu67de7y637w4jtgeuwcmh5n7788l6xnlnrgs3tvjmf)) + +## Acknowledgements + +- [Swift-DocC Plugin](https://github.com/apple/swift-docc-plugin) - [Apache License 2.0, Apple Inc.](https://github.com/apple/swift-docc-plugin/blob/main/LICENSE.txt) +- [SymbolKit](https://github.com/apple/swift-docc-symbolkit) - [Apache License 2.0, Apple Inc.](https://github.com/apple/swift-docc-symbolkit/blob/main/LICENSE.txt) +- [secp256k1.swift](https://github.com/GigaBitcoin/secp256k1.swift) - [MIT License, Copyright (c) 2020 GigaBitcoin LLC](https://github.com/GigaBitcoin/secp256k1.swift/blob/main/LICENSE) +- [CryptoSwift](https://github.com/krzyzanowskim/CryptoSwift) - [Copyright (C) 2014-3099 Marcin Krzyżanowski](https://github.com/krzyzanowskim/CryptoSwift/blob/main/LICENSE) +- [Bech32](https://github.com/0xDEADP00L/Bech32/blob/master/Sources/Bech32.swift) - [MIT License, Copyright 2018 Evolution Group Limited](https://github.com/0xDEADP00L/Bech32/blob/master/LICENSE) +- [Nos Data+Encoding.swift](https://github.com/planetary-social/nos/blob/main/Nos/Extensions/Data%2BEncoding.swift) - [MIT License, Copyright 2024 © Verse Communications](https://njump.me/note1q39598qkdc093sdq4enudjf0dall76s7n779k07nutgd9r2zt6vq96l8c2)