termcard 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +72 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,13 +1,66 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
1
3
|
# termcard
|
|
2
4
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
+
**Your business card, in the terminal.**
|
|
6
|
+
|
|
7
|
+
Created by [Ahmet Erkan Paşahan](https://aepasahan.com)
|
|
8
|
+
|
|
9
|
+
[](https://www.npmjs.com/package/termcard)
|
|
10
|
+
[](https://github.com/aepasahan/termcard/actions/workflows/ci.yml)
|
|
11
|
+
[](https://github.com/aepasahan/termcard/blob/main/LICENSE)
|
|
12
|
+
[](https://nodejs.org)
|
|
13
|
+
[](https://developer.mozilla.org/docs/Web/JavaScript/Guide/Modules)
|
|
14
|
+
[](https://www.npmjs.com/package/termcard?activeTab=dependencies)
|
|
15
|
+
|
|
16
|
+
<img src="https://raw.githubusercontent.com/aepasahan/termcard/main/docs/demo.gif" width="560" alt="Animated demo: running npx aepasahan shows a business card with a menu, then switches the card to Turkish">
|
|
17
|
+
|
|
18
|
+
</div>
|
|
19
|
+
|
|
20
|
+
## What is it?
|
|
21
|
+
|
|
22
|
+
termcard is the engine behind interactive terminal business cards. You describe yourself
|
|
23
|
+
in a small JSON file; termcard draws the card, runs the menu, speaks your visitor's
|
|
24
|
+
language and keeps everything safe. Anyone can then meet you with:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npx yourname
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
**You don't need to install this package yourself.** To create a card, run the wizard —
|
|
31
|
+
it sets everything up and publishes the card for you:
|
|
5
32
|
|
|
6
33
|
```bash
|
|
7
34
|
npm create termcard@latest
|
|
8
35
|
```
|
|
9
36
|
|
|
10
|
-
##
|
|
37
|
+
## What your visitors can do
|
|
38
|
+
|
|
39
|
+
- **Get in touch** — opens a new email to you in their mail app
|
|
40
|
+
- **Save contact** — adds your vCard to their address book
|
|
41
|
+
- **Visit your website and profiles** — LinkedIn, GitHub, X, Behance, Dribbble and more
|
|
42
|
+
- **Copy your email or phone number** to the clipboard
|
|
43
|
+
- **Switch language** — English, Turkish, German, Spanish or French, detected automatically
|
|
44
|
+
|
|
45
|
+
Flags such as `--lang tr`, `--card` (no menu) and `--vcard` work on every card.
|
|
46
|
+
|
|
47
|
+
## Features
|
|
48
|
+
|
|
49
|
+
- **One validated JSON file** instead of code to fork and edit.
|
|
50
|
+
- **Eight seasonal themes** (*thaw, bloom, blossom, solstice, ember, harvest, frost, midwinter*) that read well on dark and light terminals.
|
|
51
|
+
- **Three layouts**, optional **icons** (symbols, emoji or Nerd Font), a short **description**, and full control over which details and menu items appear — or a menu-only card.
|
|
52
|
+
- **Your own wording and languages** — every text can be changed and new languages added.
|
|
53
|
+
- **Zero dependencies, no tracking.** Values are validated and sanitized, links are restricted to web, email and phone, and no command ever runs through a shell.
|
|
54
|
+
|
|
55
|
+
## For card owners
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
npx termcard preview # see your card exactly as visitors will
|
|
59
|
+
npx termcard validate # check card.config.json and explain any mistakes
|
|
60
|
+
npx termcard build # optional: web page, vCards and curl files for your own website
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Using termcard in your own package takes two lines:
|
|
11
64
|
|
|
12
65
|
```js
|
|
13
66
|
#!/usr/bin/env node
|
|
@@ -16,12 +69,21 @@ import { start } from 'termcard';
|
|
|
16
69
|
await start(new URL('../card.config.json', import.meta.url));
|
|
17
70
|
```
|
|
18
71
|
|
|
19
|
-
|
|
72
|
+
Every option is described in the
|
|
73
|
+
[configuration guide](https://github.com/aepasahan/termcard/blob/main/docs/configuration.md).
|
|
20
74
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
75
|
+
## Requirements
|
|
76
|
+
|
|
77
|
+
Node.js 18.18 or newer, on macOS, Linux or Windows.
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
<div align="center">
|
|
82
|
+
|
|
83
|
+
Designed and built by **[Ahmet Erkan Paşahan](https://aepasahan.com)** ·
|
|
84
|
+
[LinkedIn](https://www.linkedin.com/in/aepasahan) · [GitHub](https://github.com/aepasahan/termcard) ·
|
|
85
|
+
try it: `npx aepasahan`
|
|
86
|
+
|
|
87
|
+
MIT License
|
|
26
88
|
|
|
27
|
-
|
|
89
|
+
</div>
|