Skip to content

Commit b004c12

Browse files
committed
docs: Add Damus CI status badge to README
Changelog-Added: Added CI status badge to README for Damus CI workflow Signed-off-by: d3vv3r <ananalabinfowayne@gmail.com>
1 parent c2b4a1b commit b004c12

File tree

1 file changed

+25
-15
lines changed

1 file changed

+25
-15
lines changed

README.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@
66

77
The social network you control
88

9-
A twitter-like [nostr][nostr] client for iPhone, iPad and MacOS.
9+
A twitter-like [nostr][nostr] client for iPhone, iPad and MacOS.
1010

1111
[![License: GPL-3.0](https://img.shields.io/github/license/damus-io/damus?labelColor=27303D&color=0877d2)](/LICENSE)
12+
[![Damus CI](https://github.com/damus-io/damus/actions/workflows/ci.yml/badge.svg)](https://github.com/damus-io/damus/actions/workflows/ci.yml)
1213

1314
## Download and Install
1415

@@ -25,6 +26,7 @@ iOS 16.0+ • macOS 13.0+
2526
[nostr]: https://github.com/fiatjaf/nostr
2627

2728
## How is Damus better than X/Twitter?
29+
2830
There are no toxic algorithms.\
2931
You can send or receive zaps (satoshis) without asking for permission.\
3032
[There is no central database](https://fiatjaf.com/nostr.html). Therefore, Damus is censorship resistant.\
@@ -36,6 +38,7 @@ Damus is free and open source software. \
3638
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).
3739

3840
## If there are no ads, how is Damus funded?
41+
3942
Damus offers a paid subscription 🟣 purple 🟣 https://damus.io/purple/. \
4043
Initial benefits include a unique subscriber number, subscriber badge, and auto-translate powered by DeepL.
4144

@@ -68,26 +71,29 @@ damus implements the following [Nostr Implementation Possibilities][nips]
6871
[nip42]: https://github.com/nostr-protocol/nips/blob/master/42.md
6972
[nip56]: https://github.com/nostr-protocol/nips/blob/master/56.md
7073

71-
72-
## Getting Started on Damus
74+
## Getting Started on Damus
7375

7476
### Damus iOS
75-
1) Get the Damus app on the iOS App Store: https://apps.apple.com/ca/app/damus/id1628663131
77+
78+
1. Get the Damus app on the iOS App Store: https://apps.apple.com/ca/app/damus/id1628663131
7679

7780
#### ⚙️ Settings (gear icon, top right)
78-
- Relays: You can add more relays to send your notes to by tapping the "+".
79-
- Find more relays to add: https://nostr.info/relays/
81+
82+
- Relays: You can add more relays to send your notes to by tapping the "+".
83+
- Find more relays to add: https://nostr.info/relays/
8084
- Public Key (pubkey): Your public, personal address and how people can find and tag you
81-
- Secret Key: Your *private* key unique to you. Never share your private key publicly and share with other clients at your own risk!
82-
- Save your keys somewhere safe
83-
- Log out
85+
- Secret Key: Your _private_ key unique to you. Never share your private key publicly and share with other clients at your own risk!
86+
- Save your keys somewhere safe
87+
- Log out
8488

8589
#### 🏠 Personal Feed (home icon, bottom navigation)
90+
8691
- Feed from everyone you follow
8792
- Can post notes by tapping the blue + button
8893

8994
#### Notes (under 🏠 Personal Feed)
90-
- Sending a Note is easy and it goes to both your 🏠 Personal and 🔍 Global Feeds
95+
96+
- Sending a Note is easy and it goes to both your 🏠 Personal and 🔍 Global Feeds
9197
- To tag a user you must grab their pubkey:
9298
1. Search their username in the search bar at the top of the 🔍 Global Feed and click their profile
9399
2. Tap the 🔑 icon which will copy their pubkey to your clipboard
@@ -101,35 +107,39 @@ damus implements the following [Nostr Implementation Possibilities][nips]
101107
- ♺ Reposts: Tap the repost icon which will show up in your 🏠 Personal and 🔍 Global Feeds
102108
- ♡ 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)
103109

104-
105110
#### 💬 Encrypted DMs (chat app, bottom navigation)
111+
106112
- 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
107113

108114
#### 🔍 Global Feed (magnify glass, bottom navigation)
115+
109116
- View the Global Feed from all the relays you've added in ⚙️ Settings. Currently you can only search hashtags and user names and pubkeys
110117

111118
#### 🔔 Notifications
119+
112120
- All your notifications except 💬 DMs
113121

114122
#### 👤 Change Your Profile (PFP) and Bio
123+
115124
1. Go to your Profile Page on Damus app
116125
2. Tap on Edit button at the top
117126
3. You will see text fields to update your information and bio
118127
4. For PFP, insert a URL containing your image (support video: https://cdn.jb55.com/vid/pfp-editor.mp4)
119128
5. Save
120129

130+
#### ⚡️ Request Sats
121131

122-
#### ⚡️ Request Sats
123132
Paste an invoice from your favorite LN wallet.
124-
(Sats or Satoshis are the smallest denomination of bitcoin)
125-
133+
(Sats or Satoshis are the smallest denomination of bitcoin)
126134
**Alby (browser extension)**
135+
127136
- Get the [Alby](https://getalby.com/) browser extension and create your Alby address [yourname]@getalby.com or connect your existing Lightning wallet
128137
- 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
129138
- Click the Alby extension > click Receive > enter the amount of Sats > click Get Invoice > click Copy > then paste into Damus
130139
- Note: On Damus Web it will appear as a string of characters but on Damus iOS it will appear as a clickable image
131140

132141
**Zeus (mobile app)**
142+
133143
- Download [Zeus](https://zeusln.app/) app (iOS, Google, APK)
134144
- 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
135145
- To create an invoice tap Lightning > tap Receive > type in amount > tap Create Invoice > tap Copy Invoice > paste into a new Damus note
@@ -157,6 +167,7 @@ We have a few mailing lists that anyone can join to get involved in damus develo
157167
Before starting to work on any contributions, please read [docs/CONTRIBUTING.md](./docs/CONTRIBUTING.md).
158168

159169
### Privacy
170+
160171
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.
161172

162173
The relay also learns which public keys you are requesting, meaning your public key will be tied to your IP address.
@@ -176,7 +187,6 @@ All user-facing strings must have a comment in order to provide context to trans
176187
Damus lead dev and founder Will awards developers with satoshis!
177188
There may be nostr badges awarded for contributors in the future... :)
178189

179-
180190
First contributors:
181191

182192
1. @randymcmillan

0 commit comments

Comments
 (0)