Skip to content

Commit 112d0ec

Browse files
committed
Update readme in examples directory and add the example gifs
1 parent 47c8ab0 commit 112d0ec

File tree

3 files changed

+77
-9
lines changed

3 files changed

+77
-9
lines changed

examples/README.md

Lines changed: 77 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,87 @@
11
# Example usages of the `skeleton` package
22

3-
### Basic Tab Example
4-
This example demonstrates how to create a tabs and widgets using the `skeleton` package. \
5-
You can switch tabs with `ctrl+left` and `ctrl+right` keys.\
6-
You can exit the application by pressing `ctrl+c` keys.\
7-
`Note: You can override the default key bindings by providing your own key bindings.`
3+
This repository contains various example applications built using the `skeleton` package, demonstrating different use cases and features.
4+
5+
## 🚀 Available Examples
6+
7+
### 1. Basic Tab Example
8+
A simple demonstration of creating tabs and widgets - perfect for getting started!
9+
10+
**Features:**
11+
- Basic tab management
12+
- Simple widget creation
13+
- Default key binding examples
14+
15+
**Controls:**
16+
- `ctrl+left` / `ctrl+right`: Switch between tabs
17+
- `ctrl+c`: Exit application
818

919
<a href="./fundamental-skeleton/main.go">
1020
<img width="750" src="./fundamental-skeleton/demo.gif" />
1121
</a>
1222

13-
### File Reader
14-
Basic file reader example using the `skeleton` package. \
15-
Keys: `ctrl+left` and `ctrl+right` to switch tabs, `ctrl+w` to close the tab, `ctrl+c` to exit the application.
23+
### 2. File Reader
24+
A terminal-based file explorer and reader application.
25+
26+
**Features:**
27+
- File system navigation
28+
- File content viewing
29+
- Tab management
30+
31+
**Controls:**
32+
- `ctrl+left` / `ctrl+right`: Switch between tabs
33+
- `ctrl+w`: Close current tab
34+
- `ctrl+c`: Exit application
1635

1736
<a href="./file-reader/main.go">
1837
<img width="550" src="./file-reader/demo.gif" />
19-
</a>
38+
</a>
39+
40+
### 3. System Monitor
41+
A real-time system resource monitoring application.
42+
43+
**Features:**
44+
- CPU usage monitoring
45+
- Memory usage tracking
46+
- Disk usage statistics
47+
- Real-time updates
48+
49+
**Controls:**
50+
- `ctrl+left` / `ctrl+right`: Switch between tabs
51+
- `ctrl+c`: Exit application
52+
53+
<a href="./system-monitor/main.go">
54+
<img width="550" src="./system-monitor/demo.gif" />
55+
</a>
56+
57+
### 4. News Reader
58+
A terminal-based RSS news reader application.
59+
60+
**Features:**
61+
- RSS feed parsing
62+
- News article viewing
63+
- Multiple feed support
64+
- Clean article formatting
65+
- Tab-based navigation
66+
67+
**Controls:**
68+
- `ctrl+left` / `ctrl+right`: Switch between tabs
69+
- `ctrl+c`: Exit application
70+
71+
<a href="./news-reader/main.go">
72+
<img width="550" src="./news-reader/demo.gif" />
73+
</a>
74+
75+
## 🔧 Getting Started
76+
77+
Each example is contained in its own directory and can be run independently. To try an example:
78+
79+
1. Navigate to the example directory
80+
2. Run `go mod tidy` to ensure dependencies
81+
3. Execute `go run .` to start the application
82+
83+
## 📝 Note
84+
You can customize key bindings in all examples by modifying the configuration in the respective `main.go` files.
85+
86+
## 🤝 Contributing
87+
Feel free to contribute more examples or improve existing ones through pull requests!

examples/news-reader/demo.gif

455 KB
Loading

examples/system-monitor/demo.gif

108 KB
Loading

0 commit comments

Comments
 (0)