coracle/README.md

42 lines
1.7 KiB
Markdown
Raw Normal View History

2022-12-15 18:31:47 +00:00
# What is this?
2022-11-24 19:47:03 +00:00
2022-12-24 00:02:01 +00:00
Coracle is a web client for the Nostr protocol. While Nostr is useful for many things, Coracle focuses on providing a high-quality social media experience. Check it out at [coracle.social](https://coracle.social).
2022-12-15 18:31:47 +00:00
[Dufflepud](https://github.com/staab/dufflepud) is a companion server which you can self-host. It helps Coracle with things like link previews and image uploads.
Coracle is currently in _alpha_ - expect bugs, slow loading times, and rough edges.
2022-11-24 19:47:03 +00:00
2022-12-24 00:02:01 +00:00
If you like Coracle and want to support its development, you can donate sats via [Geyser](https://geyser.fund/project/coracle).
2022-12-15 18:31:47 +00:00
# Features
2022-11-24 19:47:03 +00:00
2022-11-27 03:34:28 +00:00
- [x] Chat
- [x] Threads/social
2022-12-03 20:26:09 +00:00
- [x] Search
2022-12-15 13:55:12 +00:00
- [x] Notifications
2022-12-06 05:46:40 +00:00
- [x] Link previews
2022-12-14 06:01:26 +00:00
- [x] Add notes, follows, likes tab to profile
2022-12-15 18:31:47 +00:00
- [ ] Mentions - render done, now reference in compose
- [ ] Image uploads
2022-12-15 13:55:12 +00:00
- [ ] An actual readme
2022-12-03 20:26:09 +00:00
- [ ] Server discovery and relay publishing - https://github.com/nostr-protocol/nips/pull/32/files
2022-12-17 20:30:18 +00:00
- [ ] Support invoices https://twitter.com/jb55/status/1604131336247476224
2022-12-23 19:59:40 +00:00
- [ ] Expand/collapse large threads
- [ ] NIP 05
2022-12-15 18:31:47 +00:00
# Bugs
- [ ] Add alerts for replies to posts the user liked
- [ ] With link/image previews, remove the url from the note body if it's on a separate last line
- [ ] Stack views so scroll position isn't lost on navigation
2022-12-20 13:48:28 +00:00
- [ ] Add notification for slow relays
- [ ] Wait for 60% or so of relays to eose to balance completeness with speed
2022-12-23 19:59:40 +00:00
- [ ] Add a CSP, check for XSS in image urls
2022-12-16 17:45:58 +00:00
2022-12-24 00:02:01 +00:00
# Changelog
## 0.2.0
- [x] Completely re-worked data synchronization layer, moving from naive just-in-time requests to background listeners and a local copy stored in dexie. Events and tags, but not people are deleted from the database on logout, and old events are periodically purged.
- [x]