Welcome to the Nostr Swift Client repository! This project aims to provide a robust and easy-to-use Swift implementation for interacting with the Nostr protocol.
Nostr (Notes and Other Stuff Transmitted by Relays) is a simple, open, and decentralized protocol that enables a global, censorship-resistant social network. It's built on a foundation of cryptographic keys and relays, allowing for a truly open and resilient communication platform.
This client is designed to offer:
- Relay Communication: Connect to and interact with Nostr relays.
- Event Handling: Send and receive various Nostr event types.
- Key Management: Securely handle Nostr private and public keys.
- User Interface (WIP): A user-friendly interface for interacting with the Nostr network (as seen in the screenshot).
- Swift Native: Built entirely in Swift, leveraging Apple's ecosystem.
- Xcode (latest stable version recommended)
- Swift (latest stable version recommended)
Clone the repository:
git clone https://github.com/dfralan/a.git
cd aOpen in Xcode:
- Open the
.xcodeprojor.xcworkspacefile in Xcode.
Build and Run:
- Select your target device or simulator and build and run the project.
Once the application is running, you can:
- Connect to Nostr relays.
- Create and publish Nostr events (e.g., text notes).
- Subscribe to events from other users.
- Manage your Nostr identity.
(Further detailed usage instructions will be added as the project matures.)
Contributions are highly welcome! If you'd like to contribute, please follow these steps:
- Fork the repository.
- Create a new branch (
git checkout -b feature/your-feature-name). - Make your changes.
- Commit your changes (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature/your-feature-name). - Open a Pull Request.
Please ensure your code adheres to Swift best practices and includes appropriate tests.
This project is licensed under the MIT License.
If you have any questions or feedback, feel free to reach out to me:
- GitHub: @dfralan
Feel free to try it!