nostros/README.md
2023-01-26 08:28:04 +01:00

45 lines
1.9 KiB
Markdown

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/a3db59f4a45a43159cb129386b937a2a)](https://www.codacy.com/gh/KoalaSat/nostros/dashboard?utm_source=github.com&utm_medium=referral&utm_content=KoalaSat/nostros&utm_campaign=Badge_Grade)
[![Frontend Build](https://github.com/KoalaSat/nostros/actions/workflows/android-build.yml/badge.svg?branch=main)](https://github.com/KoalaSat/nostros/actions/workflows/android-build.yml)
[![release](https://img.shields.io/github/v/release/KoalaSat/nostros)](https://github.com/KoalaSat/nostros/releases)
[![Apache 2 license](https://img.shields.io/badge/license-Apache%202-blue)](https://github.com/KoalaSat/nostros/blob/main/LICENSE)
[![Telegram](https://img.shields.io/badge/chat-telegram-brightgreen)](https://t.me/+zhvZAE9L0X40ZjI0)
<center><a href="https://apt.izzysoft.de/fdroid/index/apk/com.nostros" target="_blank" rel="noopener noreferrer"><img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png" width="170"></a></center>
![image](https://user-images.githubusercontent.com/4659020/213927551-d2ece568-a5b9-4f1a-af99-c52019df79db.png)
# Getting Started
What is Nostr: https://github.com/nostr-protocol/nostr
Local setup: https://github.com/KoalaSat/nostros/blob/main/SETUP.md
# Features
- [x] Send public notes and replies
- [x] Profile edition
- [x] Reposts
- [x] Reactions (likes & dislikes)
- [x] Encrypted direct messsages
- [x] Notifications feed
- [x] NIP-05 validation
- [x] Lightning Network invoice generation for profiles and notes
- [x] Sensitive content flag
- [x] Multirelay management
- [x] Bech-32 keys
- [ ] Public Feed
- [ ] Channels
- [ ] Deep Links
- [ ] Search
# Kudos
- Inspired by https://github.com/jb55/nostr-js and https://github.com/fiatjaf/nostr-tools
- Discovered thanks to https://lunaticoin.com
# Support
Project's Address: bc1q8xjlxxwpsck429zr7ff466yax0k3lhp9fmm2et
LN Address: nostros@getalby.com