damus

nostr ios client
git clone git://jb55.com/damus
Log | Files | Refs | README | LICENSE

README.md (8842B)

      1 [![Run Test Suite](https://github.com/damus-io/damus/actions/workflows/run-tests.yaml/badge.svg?branch=master)](https://github.com/damus-io/damus/actions/workflows/run-tests.yaml)
      2 
      3 # damus
      4 
      5 A twitter-like [nostr][nostr] client for iPhone, iPad and MacOS. 
      6 
      7 <img src="./ss.png" width="50%" height="50%" />
      8 
      9 [nostr]: https://github.com/fiatjaf/nostr
     10 
     11 ## How is Damus better than X/Twitter?
     12 There are no toxic algorithms.\
     13 You can send or receive zaps (satoshis) without asking for permission.\
     14 [There is no central database](https://fiatjaf.com/nostr.html). Therefore, Damus is censorship resistant.\
     15 There are no ads.\
     16 You don't have to reveal sensitive personal information to sign up.\
     17 No email is required. \
     18 No phone number is required. \
     19 Damus is free and open source software. \
     20 There is no Big Tech moat. Therefore, seamless interoperability with thousands or millions of other nostr apps is possible, and is how [Damus and nostr win](https://www.youtube.com/watch?v=qTixqS-W1yo).
     21 
     22 ## If there are no ads, how is Damus funded?
     23 Damus offers a paid subscription 🟣 purple 🟣 https://damus.io/purple/. \
     24 Initial benefits include a unique subscriber number, subscriber badge, and auto-translate powered by DeepL.
     25 
     26 Damus has also graciously received donations or grants from hundreds of Damus users, [Opensats](https://opensats.org/), and the [Human Rights Foundation](https://hrf.org/).
     27 
     28 ## Spec Compliance
     29 
     30 damus implements the following [Nostr Implementation Possibilities][nips]
     31 
     32 - [NIP-01: Basic protocol flow][nip01]
     33 - [NIP-04: Encrypted direct message][nip04]
     34 - [NIP-08: Mentions][nip08]
     35 - [NIP-10: Reply conventions][nip10]
     36 - [NIP-12: Generic tag queries (hashtags)][nip12]
     37 - [NIP-19: bech32-encoded entities][NIP19]
     38 - [NIP-21: nostr: URI scheme][NIP21]
     39 - [NIP-25: Reactions][NIP25]
     40 - [NIP-42: Authentication of clients to relays][nip42]
     41 - [NIP-56: Reporting][nip56]
     42 
     43 [nips]: https://github.com/nostr-protocol/nips
     44 [nip01]: https://github.com/nostr-protocol/nips/blob/master/01.md
     45 [nip04]: https://github.com/nostr-protocol/nips/blob/master/04.md
     46 [nip08]: https://github.com/nostr-protocol/nips/blob/master/08.md
     47 [nip10]: https://github.com/nostr-protocol/nips/blob/master/10.md
     48 [nip12]: https://github.com/nostr-protocol/nips/blob/master/12.md
     49 [nip19]: https://github.com/nostr-protocol/nips/blob/master/19.md
     50 [nip21]: https://github.com/nostr-protocol/nips/blob/master/21.md
     51 [nip25]: https://github.com/nostr-protocol/nips/blob/master/25.md
     52 [nip42]: https://github.com/nostr-protocol/nips/blob/master/42.md
     53 [nip56]: https://github.com/nostr-protocol/nips/blob/master/56.md
     54 
     55 
     56 ## Getting Started on Damus 
     57 
     58 ### Damus iOS
     59 1) Get the Damus app on the iOS App Store: https://apps.apple.com/ca/app/damus/id1628663131
     60 
     61 #### ⚙️ Settings (gear icon, top right)
     62 - Relays: You can add more relays to send your notes to by tapping the "+". 
     63   - Find more relays to add: https://nostr.info/relays/ 
     64 - Public Key (pubkey): Your public, personal address and how people can find and tag you
     65  - Secret Key: Your *private* key unique to you. Never share your private key publicly and share with other clients at your own risk!
     66    - Save your keys somewhere safe
     67  - Log out
     68 
     69 #### 🏠 Personal Feed (home icon, bottom navigation)
     70 - Feed from everyone you follow
     71 - Can post notes by tapping the blue + button
     72 
     73 #### Notes (under 🏠 Personal Feed)
     74 - Sending a Note is easy and it goes to both your 🏠 Personal and 🔍 Global Feeds 
     75 - To tag a user you must grab their pubkey:
     76   1. Search their username in the search bar at the top of the 🔍 Global Feed and click their profile
     77   2. Tap the 🔑 icon which will copy their pubkey to your clipboard
     78   3. Go back to your 🏠 Personal Feed and tap the blue + button to compose your Note
     79   4. Add @ directly followed by the pubkey (e.g., `@npub1xtscya34g58tk0z605fvr788k263gsu6cy9x0mhnm87echrgufzsevkk5s`)
     80 - 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.
     81 - Currently you can't delete your Notes in the iOS app
     82 - 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
     83 - Engaging with Notes
     84   - 💬 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
     85   - ♺ Reposts: Tap the repost icon which will show up in your 🏠 Personal and 🔍 Global Feeds
     86   - ♡ 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)
     87 
     88 
     89 #### 💬 Encrypted DMs (chat app, bottom navigation)
     90 - 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
     91 
     92 #### 🔍 Global Feed (magnify glass, bottom navigation)
     93 - View the Global Feed from all the relays you've added in ⚙️ Settings. Currently you can only search hashtags and user names and pubkeys
     94 
     95 #### 🔔 Notifications
     96 - All your notifications except 💬 DMs
     97 
     98 #### 👤 Change Your Profile (PFP) and Bio
     99 1. Go to your Profile Page on Damus app
    100 2. Tap on Edit button at the top
    101 3. You will see text fields to update your information and bio
    102 4. For PFP, insert a URL containing your image (support video: https://cdn.jb55.com/vid/pfp-editor.mp4)
    103 5. Save
    104 
    105 
    106 #### ⚡️ Request Sats 
    107 Paste an invoice from your favorite LN wallet.
    108     (Sats or Satoshis are the smallest denomination of bitcoin)
    109 	
    110 **Alby (browser extension)**
    111 - Get the [Alby](https://getalby.com/) browser extension and create your Alby address [yourname]@getalby.com or connect your existing Lightning wallet
    112 - Convert your Damus secret key from nsec to hex at https://damus.io/key then go to Settings in Alby and under the Nostr section at the bottom of the page add your private hex key. You can also generate new address in the extension
    113 - Click the Alby extension > click Receive > enter the amount of Sats > click Get Invoice > click Copy > then paste into Damus
    114 - Note: On Damus Web it will appear as a string of characters but on Damus iOS it will appear as a clickable image
    115 
    116 **Zeus (mobile app)**
    117 - Download [Zeus](https://zeusln.app/) app (iOS, Google, APK)
    118 - Tap Get Started button > tap Connect a node > click on + sign (top right) > select Indhub > press Scan Lndhub QR > (from the Alby browser extension… click your account on the top left > click Manage Accounts > click 3-dot menu to right of your account and click Export Account to get a QR code then go back to Zeus app) > scan the QR Code and tap Save Node Config button
    119 - To create an invoice tap Lightning > tap Receive > type in amount > tap Create Invoice > tap Copy Invoice > paste into a new Damus note
    120 
    121 ## Contributing
    122 
    123 Contributors welcome! Start by examining known issues: https://github.com/damus-io/damus/issues.
    124 
    125 ### Mailing lists
    126 
    127 We have a few mailing lists that anyone can join to get involved in damus development:
    128 
    129 - [dev][dev-list] - development discussions
    130 - [patches][patches-list] - code submission and review
    131 - [product][product-list] - product discussions
    132 - [design][design-list] - design discussions
    133 
    134 [dev-list]: https://damus.io/list/dev
    135 [patches-list]: https://damus.io/list/patches
    136 [product-list]: https://damus.io/list/product
    137 [design-list]: https://damus.io/list/design
    138 
    139 ### Contributing
    140 
    141 See [docs/CONTRIBUTING.md](./docs/CONTRIBUTING.md)
    142 
    143 ### Privacy
    144 Your internet protocol (IP) address is exposed to the relays you connect to, and third party media hosters (e.g. nostr.build, imgur.com, giphy.com, youtube.com etc.) that render on Damus. If you want to improve your privacy, consider utilizing a service that masks your IP address (e.g. a VPN) from trackers online.
    145 
    146 The relay also learns which public keys you are requesting, meaning your public key will be tied to your IP address.
    147 
    148 It is public information which other profiles (npubs) you are exchanging DMs with. The content of the DMs is encrypted.
    149 
    150 ### Translations
    151 
    152 Translators welcome! Join the [Transifex][transifex] project.
    153 
    154 All user-facing strings must have a comment in order to provide context to translators. If a SwiftUI component has a `comment` parameter, use that. Otherwise, wrap your string with `NSLocalizedString` with the `comment` field populated.
    155 
    156 [transifex]: https://explore.transifex.com/damus/damus-ios/
    157 
    158 ### Awards
    159 
    160 Damus lead dev and founder Will awards developers with satoshis!
    161 There may be nostr badges awarded for contributors in the future... :)
    162 
    163 
    164 First contributors:
    165 
    166 1. @randymcmillan
    167 2. @jcarucci27
    168 
    169 ### git log bot
    170 
    171 npub1fjtdwclt9lspjy8huu3qklr7eklp5uq90u6yh8mec290pqxraccqlufnas