nostros/README.md

58 lines
2.2 KiB
Markdown
Raw Normal View History

2022-10-26 18:42:45 +00:00
[![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)
2022-10-25 23:06:23 +00:00
[![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)
2022-10-29 13:51:57 +00:00
[![release](https://img.shields.io/github/v/release/KoalaSat/nostros)](https://github.com/KoalaSat/nostros/releases)
2022-10-25 23:04:19 +00:00
[![Apache 2 license](https://img.shields.io/badge/license-Apache%202-blue)](https://github.com/KoalaSat/nostros/blob/main/LICENSE)
2022-10-31 11:03:38 +00:00
[![Telegram](https://img.shields.io/badge/chat-telegram-brightgreen)](https://t.me/+zhvZAE9L0X40ZjI0)
2022-10-24 20:35:21 +00:00
2023-01-25 12:51:38 +00:00
<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>
2022-10-24 17:43:22 +00:00
2023-02-13 20:09:09 +00:00
![Frame 360](https://user-images.githubusercontent.com/4659020/218563725-08732841-56f6-4444-b0bf-f01230b47ece.png)
2022-10-24 17:43:22 +00:00
2022-10-24 17:47:25 +00:00
# Getting Started
2022-10-24 17:43:22 +00:00
2023-02-11 08:55:32 +00:00
What is Nostr: https://www.nostr.how
2022-10-29 19:25:36 +00:00
2022-11-03 21:42:58 +00:00
Local setup: https://github.com/KoalaSat/nostros/blob/main/SETUP.md
2022-10-24 17:43:22 +00:00
2023-02-12 17:24:17 +00:00
Nostros chat
2023-02-12 18:54:23 +00:00
2023-02-12 17:24:17 +00:00
```
8d37308d97356600f67a28039d598a52b8c4fa1b73ef6f2e7b7d40197c3afa56
```
2023-01-25 12:51:38 +00:00
# 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
2023-01-29 11:18:20 +00:00
- [x] Public Feed
- [x] Block users and content
2023-02-13 08:21:32 +00:00
- [X] Channels
2023-02-10 00:37:54 +00:00
- [x] Deep Links
2023-01-26 07:28:04 +00:00
- [ ] Search
2023-02-10 00:37:54 +00:00
- [x] Mnemonic login
2023-02-10 14:47:05 +00:00
- [x] Upload images to hosting services
- [x] Push all data to a relay
- [x] Global feed filters and blocked users
- [x] Relay colouring
2023-02-13 20:09:09 +00:00
- [x] Push data to Umbrel relay
2022-10-24 17:47:25 +00:00
# Kudos
2023-01-18 16:29:19 +00:00
- Inspired by https://github.com/jb55/nostr-js and https://github.com/fiatjaf/nostr-tools
2022-10-24 17:47:25 +00:00
- Discovered thanks to https://lunaticoin.com
2022-11-08 18:58:33 +00:00
# Support
2022-10-24 17:43:22 +00:00
2022-11-08 18:21:56 +00:00
Project's Address: bc1q8xjlxxwpsck429zr7ff466yax0k3lhp9fmm2et
2022-11-08 18:58:51 +00:00
2023-01-03 22:51:26 +00:00
LN Address: nostros@getalby.com