diff --git a/README.md b/README.md index 48f1a60..fd4401b 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,22 @@ -# cosanostr +# CosaNostr -PWA Nostr Client +CosaNostr is an open source and free forever Nostr client created with Flutter and Dart. It is designed to be a progressive web app (PWA), which means it works on ANY device on ANY platform. -## Getting Started +## Project Description +CosaNostr is a project by solo developer plotsklapps, who is learning about the Nostr protocol by building something cool. The aim of this project is to create a powerful and user-friendly Nostr client that provides seamless communication across devices. -This project is a starting point for a Flutter application. +## Features +- Cross-platform: Works on desktop, mobile, and web. +- PWA focused: Provides native-like experiences across different platforms. +- Free and Open Source: CosaNostr is released under the MIT License, so you can use it for personal or commercial purposes. -A few resources to get you started if this is your first Flutter project: +## Current Status +To check out the current status of the CosaNostr project online, visit [https://cosanostr.app](https://cosanostr.app). There you will find information about the latest releases, features, and updates. -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) +## Contributing +Contributions to CosaNostr are greatly appreciated. If you'd like to contribute, please fork the repository and create a pull request. You can also report bugs or request new features by opening an issue on GitHub. -For help getting started with Flutter development, view the -[online documentation](https://docs.flutter.dev/), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +Before making any contributions, please read the Contribution Guidelines for more information. + +## License +CosaNostr is released under the MIT License. See the LICENSE file for details.