mirror of
git://jb55.com/damus
synced 2024-09-29 16:30:44 +00:00
Update README.md
-added purple -added DM privacy warning -updated NIPs -added comparison vs twitter
This commit is contained in:
parent
035181b02a
commit
e72e7b7196
40
README.md
40
README.md
@ -2,12 +2,25 @@
|
|||||||
|
|
||||||
# damus
|
# damus
|
||||||
|
|
||||||
A twitter-like [nostr][nostr] client for iPhone, iPad and MacOS.
|
A twitter-like [nostr][nostr] client for iPhone, iPad and MacOS.
|
||||||
|
|
||||||
<img src="./ss.png" width="50%" height="50%" />
|
<img src="./ss.png" width="50%" height="50%" />
|
||||||
|
|
||||||
[nostr]: https://github.com/fiatjaf/nostr
|
[nostr]: https://github.com/fiatjaf/nostr
|
||||||
|
|
||||||
|
## How is Damus better than twitter?
|
||||||
|
There are no toxic algorithms.
|
||||||
|
You can send or receive zaps (satoshis) without asking for permission.
|
||||||
|
[There is no central database](https://fiatjaf.com/nostr.html)). Therefore, Damus is censorship resistant.
|
||||||
|
There are no ads.
|
||||||
|
You don't have to reveal sensitive personal information to sign up.
|
||||||
|
No email is required.
|
||||||
|
No phone number is required.
|
||||||
|
|
||||||
|
## If there are no ads, how does Damus make money?
|
||||||
|
Damus offers a paid subscription 🟣 purple 🟣 https://damus.io/purple/.
|
||||||
|
Initial benefits include a unique subscriber number, subscriber badge, and auto-translate powered by DeepL.
|
||||||
|
|
||||||
## Spec Compliance
|
## Spec Compliance
|
||||||
|
|
||||||
damus implements the following [Nostr Implementation Possibilities][nips]
|
damus implements the following [Nostr Implementation Possibilities][nips]
|
||||||
@ -16,14 +29,23 @@ damus implements the following [Nostr Implementation Possibilities][nips]
|
|||||||
- [NIP-08: Mentions][nip08]
|
- [NIP-08: Mentions][nip08]
|
||||||
- [NIP-10: Reply conventions][nip10]
|
- [NIP-10: Reply conventions][nip10]
|
||||||
- [NIP-12: Generic tag queries (hashtags)][nip12]
|
- [NIP-12: Generic tag queries (hashtags)][nip12]
|
||||||
|
- [NIP-19: bech32-encoded entities][NIP19]
|
||||||
|
- [NIP-21: nostr: URI scheme][NIP21]
|
||||||
|
- [NIP-25: Reactions][NIP25]
|
||||||
- [NIP-42: Authentication of clients to relays][nip42]
|
- [NIP-42: Authentication of clients to relays][nip42]
|
||||||
|
- [NIP-56: Reporting][nip56]
|
||||||
|
|
||||||
[nips]: https://github.com/nostr-protocol/nips
|
[nips]: https://github.com/nostr-protocol/nips
|
||||||
[nip01]: https://github.com/nostr-protocol/nips/blob/master/01.md
|
[nip01]: https://github.com/nostr-protocol/nips/blob/master/01.md
|
||||||
[nip08]: https://github.com/nostr-protocol/nips/blob/master/08.md
|
[nip08]: https://github.com/nostr-protocol/nips/blob/master/08.md
|
||||||
[nip10]: https://github.com/nostr-protocol/nips/blob/master/10.md
|
[nip10]: https://github.com/nostr-protocol/nips/blob/master/10.md
|
||||||
[nip12]: https://github.com/nostr-protocol/nips/blob/master/12.md
|
[nip12]: https://github.com/nostr-protocol/nips/blob/master/12.md
|
||||||
|
[nip19]: https://github.com/nostr-protocol/nips/blob/master/19.md
|
||||||
|
[nip21]: https://github.com/nostr-protocol/nips/blob/master/21.md
|
||||||
|
[nip25]: https://github.com/nostr-protocol/nips/blob/master/25.md
|
||||||
[nip42]: https://github.com/nostr-protocol/nips/blob/master/42.md
|
[nip42]: https://github.com/nostr-protocol/nips/blob/master/42.md
|
||||||
|
[nip56]: https://github.com/nostr-protocol/nips/blob/master/56.md
|
||||||
|
|
||||||
|
|
||||||
## Getting Started on Damus
|
## Getting Started on Damus
|
||||||
|
|
||||||
@ -49,18 +71,14 @@ damus implements the following [Nostr Implementation Possibilities][nips]
|
|||||||
2. Tap the 🔑 icon which will copy their pubkey to your clipboard
|
2. Tap the 🔑 icon which will copy their pubkey to your clipboard
|
||||||
3. Go back to your 🏠 Personal Feed and tap the blue + button to compose your Note
|
3. Go back to your 🏠 Personal Feed and tap the blue + button to compose your Note
|
||||||
4. Add @ directly followed by the pubkey (e.g., `@npub1xtscya34g58tk0z605fvr788k263gsu6cy9x0mhnm87echrgufzsevkk5s`)
|
4. Add @ directly followed by the pubkey (e.g., `@npub1xtscya34g58tk0z605fvr788k263gsu6cy9x0mhnm87echrgufzsevkk5s`)
|
||||||
- You can also long-press a Note to grab their User ID aka pubkey or Note ID to link directly to a Note.
|
- You can also tap the ellipsis menu of a Note (three dots in top right of note) to grab their User ID aka pubkey or Note ID to link directly to a Note.
|
||||||
- Currently you can't delete your Notes in the iOS app
|
- Currently you can't delete your Notes in the iOS app
|
||||||
- Share images by pasting the image url which you can grab from imgbb, imgur, etc. (i.e., `https://i.ibb.co/2SHZbwm/alpha60.jpg`). Currently images only load for people you follow in the 🏠 Personal Feed. Images are not automatically loaded in 🔍 Global Feed
|
- Share images by pasting the image url which you can grab from nostr.build, imgbb, imgur, etc. (i.e., `https://i.ibb.co/2SHZbwm/alpha60.jpg`). Currently images only load for people you follow in the 🏠 Personal Feed. Images are not automatically loaded in 🔍 Global Feed
|
||||||
- Engaging with Notes
|
- Engaging with Notes
|
||||||
- 💬 Replying to a Note: Tap the chat icon underneath the note. This will show up in the users’ notifications and in your 🏠 Personal and 🔍 Global Feeds
|
- 💬 Replying to a Note: Tap the chat icon underneath the note. This will show up in the users’ notifications and in your 🏠 Personal and 🔍 Global Feeds
|
||||||
- ♺ Reposts: Tap the repost icon which will show up in your 🏠 Personal and 🔍 Global Feeds
|
- ♺ Reposts: Tap the repost icon which will show up in your 🏠 Personal and 🔍 Global Feeds
|
||||||
- ♡ Likes: Tap the heart icon. Users will not get a notification, and cannot see who liked their note (currently, web clients can see your pfp only)
|
- ♡ Likes: Tap the heart icon. Users will not get a notification, and cannot see who liked their note (currently, web clients can see your pfp only)
|
||||||
- Formatting Notes (may not format as intended in other web clients)
|
|
||||||
- Italics: 1 asterisk `*italic*`
|
|
||||||
- Bold: 2 asterisk `**bold**`
|
|
||||||
- Strikethrough: 1 tildes `~strikethrough~`
|
|
||||||
- Code: 1 back-tick `` `code` ``
|
|
||||||
|
|
||||||
#### 💬 Encrypted DMs (chat app, bottom navigation)
|
#### 💬 Encrypted DMs (chat app, bottom navigation)
|
||||||
- Tap the chat icon and you'll notice there's nothing to see at first. Go to a user profile and tap the 💬 chat icon next to the follow button to begin a DM
|
- Tap the chat icon and you'll notice there's nothing to see at first. Go to a user profile and tap the 💬 chat icon next to the follow button to begin a DM
|
||||||
@ -78,7 +96,9 @@ damus implements the following [Nostr Implementation Possibilities][nips]
|
|||||||
4. For PFP, insert a URL containing your image (support video: https://cdn.jb55.com/vid/pfp-editor.mp4)
|
4. For PFP, insert a URL containing your image (support video: https://cdn.jb55.com/vid/pfp-editor.mp4)
|
||||||
5. Save
|
5. Save
|
||||||
|
|
||||||
|
|
||||||
#### ⚡️ Request Sats
|
#### ⚡️ Request Sats
|
||||||
|
Paste an invoice from your favorite LN wallet.
|
||||||
(Sats or Satoshis are the smallest denomination of bitcoin)
|
(Sats or Satoshis are the smallest denomination of bitcoin)
|
||||||
|
|
||||||
**Alby (browser extension)**
|
**Alby (browser extension)**
|
||||||
@ -119,6 +139,8 @@ Your internet protocol (IP) address is exposed to the relays you connect to, and
|
|||||||
|
|
||||||
The relay also learns which public keys you are requesting, meaning your public key will be tied to your IP address.
|
The relay also learns which public keys you are requesting, meaning your public key will be tied to your IP address.
|
||||||
|
|
||||||
|
It is public information which other profiles (npubs) you are exchanging DMs with. The content of the DMs is encrypted.
|
||||||
|
|
||||||
### Translations
|
### Translations
|
||||||
|
|
||||||
Translators welcome! Join the [Transifex][transifex] project.
|
Translators welcome! Join the [Transifex][transifex] project.
|
||||||
@ -129,8 +151,10 @@ All user-facing strings must have a comment in order to provide context to trans
|
|||||||
|
|
||||||
### Awards
|
### Awards
|
||||||
|
|
||||||
|
Damus lead dev and founder Will awards developers with satoshis!
|
||||||
There may be nostr badges awarded for contributors in the future... :)
|
There may be nostr badges awarded for contributors in the future... :)
|
||||||
|
|
||||||
|
|
||||||
First contributors:
|
First contributors:
|
||||||
|
|
||||||
1. @randymcmillan
|
1. @randymcmillan
|
||||||
|
Loading…
Reference in New Issue
Block a user