README

5624b4a · gmorell · 2026-01-18 22:39

7 files +56 -0

Files changed

added README.md
+56 −0
@@ -0,0 +1,56 @@
1 +# PPL
2 +
3 +A Rust CLI tool for managing and tracking significant dates for the people in your life.
4 +
5 +## Features
6 +
7 +Just enough to get by.
8 +
9 +### Storage
10 +
11 +Shipping a syncable database for the following information
12 +
13 +- [x] PPl
14 + - [x] Contact information
15 + - [x] Tiers
16 + - [x] Traits
17 + - [x] Significant Dates
18 +- [x] Tier Defaults ( Emoji + Color )
19 +- [x] Trait Defaults ( Emoji + Color )
20 +- [x] Reminder Configuration
21 +
22 +### MOTD
23 +
24 +Put a message of the day in your bashrc to remind you of important dates.
25 +```ppl motd```
26 +
27 +![motd.png](screenshots/motd.png)
28 +
29 +### TUI
30 +
31 +A Terminal UI for managing all the various stored information in the database.
32 +
33 +#### Default View
34 +
35 +PPL List, shows all configured ppl, their tiers, traits and information
36 +
37 +![default.png](screenshots/default.png)
38 +
39 +
40 +#### Calendar View
41 +
42 +Upcoming Anniversaries
43 +
44 +![calendar.png](screenshots/calendar.png)
45 +
46 +#### Tier View
47 +
48 +Add and Modify Tiers and Defaults
49 +
50 +![tiers.png](screenshots/tiers.png)
51 +
52 +### Trait View
53 +
54 +Add and Modify Traits and Defaults
55 +
56 +![img.png](screenshots/traits.png)
modified ?
+0 −0

Binary file — not rendered.

modified ?
+0 −0

Binary file — not rendered.

modified ?
+0 −0

Binary file — not rendered.

modified ?
+0 −0

Binary file — not rendered.

modified ?
+0 −0

Binary file — not rendered.

Parents: 499f1fd