UNPKG

friendlog

Version:

[Install Node](https://nodejs.org/en/download/package-manager/) (if you haven't before)

github.com/marwahaha/friendlog

marwahaha/friendlog

62 lines (48 loc) • 1.23 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
## Setup [Install Node](https://nodejs.org/en/download/package-manager/) (if you haven't before) ``` npm install -g friendlog ``` ## Shortcuts Add tab-completion and the shortcut `flh` for `fl hangout`! ``` fl shortcuts >> ~/.bash_profile && source ~/.bash_profile ``` ## Basic Usage ``` $ fl help ``` You can use `friendlog` or `fl`. Add friends and an ideal interval (in days) you'd like to see them: ``` $ friendlog add Alice 5 # your best friend $ fl add "Bob Doe" 15 # not quite so close $ fl add Kunal 10 ``` Log a hangout: ``` $ fl hangout Alice 2018-01-01 "Got coffee" $ flh Kunal 2018-03-19 "Created friendlog" ``` See who you should hang out with next and when: ``` $ fl list 2018-01-06 Alice 2018-03-29 Kunal new Bob Doe # no hangouts logged yet ``` See history of hangouts: ``` $ fl history NAME DATE MEMO Alice 2018-01-06 Got coffee Kunal 2018-03-29 Created friendlog ``` See info about friend: ``` $ fl info Kunal { name: 'Kunal', interval: 10 } ``` ## Contributing Linting is enforced with pre-commit and pre-push hooks. `npm run lint-fix` will help! Publish easily: `npm version [major|minor|patch]` will bump version numbers; `npm publish` will publish package.