commit 5e0a243eaaad070ab7c77b49ca6b6302ca4e3ff2
parent cd591307a80c6600eb9727efb62777394f919804
Author: Tyler <tyler.mathews@gmail.com>
Date: Tue, 20 Dec 2022 00:27:27 -0600
Added explainer of the Damus app
Includes overview of navigation icons and their functionality, how to update profile and install extensions, receive LN payments, etc.
Diffstat:
| M | README.md | | | 69 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 69 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -22,6 +22,75 @@ damus implements the following [Nostr Implementation Possibilities][nips]
[nip10]: https://github.com/nostr-protocol/nips/blob/master/10.md
[nip12]: https://github.com/nostr-protocol/nips/blob/master/12.md
+## Getting Started on Damus
+
+### Damus iOS
+1) Get the Damus app on Testflight: https://testflight.apple.com/join/CLwjLxWl
+
+#### ⚙️ Settings (gear icon, top right)
+- Relays: You can add more relays to send your notes to by tapping the "+".
+ - Find more relays to add: https://nostr.info/relays/
+- Public Key (pubkey): Your public, personal address and how people can find and tag you
+ - Secret Key: Your *private* key unique to you. Never share your private key publically and share with other clients at your own risk!
+ - Save your keys somewhere safe
+ - Log out
+
+#### 🏠 Personal Feed (home icon, bottom navigation)
+- Feed from everyone you follow
+- Can post notes by tapping the blue + button
+
+#### Notes (under 🏠 Personal Feed)
+- Sending a Note is easy and it goes to both your 🏠 Personal and 🔍 Global Feeds
+- To tag a user you must grab their pubkey:
+ 1. Search their username in the search bar at the top of the 🔍 Global Feed and click their profile
+ 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
+ 4. Add @ direcly 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.
+- 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
+- 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
+ - ♺ 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)
+- Formatting Notes (may not format as intended in other web clients)
+ - Italics: 1 asterisk `*italic*`
+ - Bold: 2 asterisk `**bold**`
+ - Strikethrough: 2 tildes `~~strikethrough~~`
+ - Code: 1 back-tick ``code``
+
+#### 💬 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
+
+#### 🔍 Global Feed (magnify glass, bottom navigation)
+- View the Global Feed from all the relays you've added in ⚙️ Settings. Currently you can only search hashtags and user names and pubkeys
+
+#### 🔔 Notifications
+- All your notifications except 💬 DMs
+
+#### 👤 Change Your Profile (PFP) and Bio
+- Currently you can't change your pfp on the Damus app (coming soon!). Here's how to do it on other clients (do at your own risk)
+1. Get the [Alby](https://getalby.com/) or [nos2x](https://chrome.google.com/webstore/detail/nos2x/kpgefcfmnafjgpblomihpgmejjdanjjp) browser extension (Chrome, Brave)
+2. Go to https://damus.io/key to convert your nsec key (secret key in ⚙️ Settings) into a hex version
+3.1 For Alby, right-click the extension, select Options and scroll to the Nostr section to enter your secret hex key
+3.2 For nos2x, right-click the extension, select Options, then and add the relay `wss://relay.damus.io` and select both read and write, click Save, then enter your secret hex key and click save
+4. Visit https://metadata.nostr.com and your profile data should auto-populate from the extension. If not click the extension or refresh the page
+5. Add your image using a hosting site like imgbb.com
+
+#### ⚡️ Request Sats
+ (Sats or Satoshis are the smallest denomination of bitcoin)
+
+**Alby (browser extension)**
+- Get the Alby browser extension: https://getalby.com and create your Alby address [yourname]@getalby.com
+- Convert your Damus private key from nsec to hex at https://metadata.nostr.com then go to Settings in Alby and under the Nostr section at the bottom of the page add your private hex key
+- Click the Alby extension > click Receive > enter the amount of Sats > click Get Invoice > click Copy > then paste into Damus
+- Note: On Damus Web it will appear as a string of characters but on Damus iOS it will appear as a clickable image
+
+**Zeus (mobile app)**
+- Download Zeus app https://zeusln.app/ (iOS, Google, APK)
+- 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
+- To create an invoice tap Lightning > tap Receive > type in amount > tap Create Invoice > tap Copy Invoice > paste into a new Damus note
+
## Contributing
Contributors welcome! [Email patches][git-send-email] to jb55@jb55.com are preferred, but I accept PRs on github as well.
