nostros/README.md
2023-11-21 21:24:11 +01:00

64 lines
2.4 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)
[<img src="https://github.com/machiav3lli/oandbackupx/blob/034b226cea5c1b30eb4f6a6f313e4dadcbb0ece4/badge_github.png"
alt="Get it on GitHub"
height="65">](https://github.com/KoalaSat/nostros/releases)
[<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png" height="65">](https://apt.izzysoft.de/fdroid/index/apk/com.nostros)
[![image](https://user-images.githubusercontent.com/4659020/225482880-07677ab8-0315-4f9c-bd2d-722538c9f9a2.png)](https://nostros.net/)
# Getting Started
https://nostros.net/
What is Nostr: https://www.nostr.how
Local setup: https://github.com/KoalaSat/nostros/blob/main/SETUP.md
Nostros chat
```
8d37308d97356600f67a28039d598a52b8c4fa1b73ef6f2e7b7d40197c3afa56
```
# Features
- [x] Send public notes and replies
- [x] Profile edition
- [x] Reposts
- [x] Reactions (likes & dislikes)
- [x] Encrypted direct messsages
- [x] NIP-05 validation
- [x] Lightning Network invoice generation for profiles and notes
- [x] Sensitive content flag
- [x] Bech-32 keys
- [x] Block users and content
- [x] Groups
- [x] Deep Links
- [x] Search (content and hashtags)
- [x] Mnemonic login
- [x] Upload images to hosting services
- [x] Push all data to a relay
- [x] Global feed filters and blocked users
- [x] Relay colouring
- [x] Push events to private relay
- [x] Zaps
- [x] Bookmarks (public and private)
- [x] Gossip model
- [x] Authentication of clients to relays (NIP-42)
# 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