Skip to content

Commit 0e70974

Browse files
committed
updated README with latest features
1 parent 8a29b49 commit 0e70974

File tree

4 files changed

+17
-3
lines changed

4 files changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,26 +24,34 @@ information is p2p distributed using gun and end-to-end encrypted using gun/sea.
2424
built with SvelteKit and GunDB.
2525
</p>
2626

27+
## 🤔 how to use
28+
29+
1. go to https://splitio.vercel.app (or self-host yours!)
30+
2. create a group with any name
31+
3. send your friends the long url to start sharing bills! no accounts required
32+
2733
## 🌟 showcase
2834
<table>
2935
<tr>
3036
<a href=""><img width="21%" src="./screenshots/screen1.png"/></a>
3137
<a href=""><img width="21%" src="./screenshots/screen4.png"/></a>
32-
<a href=""><img width="21%" src="./screenshots/screen6.png"/></a>
38+
<a href=""><img width="21%" src="./screenshots/screen2.png"/></a>
3339
<div/>
3440
</tr>
3541
<tr>
36-
<a href=""><img width="21%" src="./screenshots/screen2.png"/></a>
3742
<a href=""><img width="21%" src="./screenshots/screen3.png"/></a>
3843
<a href=""><img width="21%" src="./screenshots/screen5.png"/></a>
44+
<a href=""><img width="21%" src="./screenshots/screen6.png"/></a>
45+
3946
</tr>
4047
</table>
4148

4249
## 📝 next steps
4350

4451
some extra desired features/fixes are:
4552
- ~~compute who-owes-what~~ (done!)
46-
- add settlements
53+
- ~~add settlements~~ (done! just click on who you want to pay in the balances dialog)
54+
- ~~show date in group transactions~~ (done!)
4755
- calculate monthly stats (expenses amount in last 30 days)
4856
- allow changing currency symbol ($, €, ¥, etc)
4957
- ~~favorite a group for easy access in PWA (or provide some kind of shortcut)~~ (disabled PWA for now)
@@ -56,6 +64,12 @@ some extra desired features/fixes are:
5664
3. start the server (with hot reloading): `npm run dev`
5765
4. navigate to [localhost:3000](http://localhost:5000)
5866

67+
## ⚠️ disclaimer
68+
69+
even though all information is encrypted and decrypted on-device (e2ee), i'm not a security expert. given this, i'm looking for more people to review the encryption code and fix any vulnerabilities.
70+
71+
also, as the code uses Gun with community servers and localStorage, persisting data for long amounts of time could be an issue. try to open your group often to get more devices updated. in the future, i should probably self-host a Gun relay, though i don't currently have the means necessary.
72+
5973
## ⚖️ license
6074

6175
MIT

screenshots/screen4.png

36.5 KB
Loading

screenshots/screen5.png

25.5 KB
Loading

screenshots/screen6.png

45 KB
Loading

0 commit comments

Comments
 (0)