Skip to content

Commit 3c85c7e

Browse files
committed
update readme
1 parent 58a5511 commit 3c85c7e

File tree

2 files changed

+19
-13
lines changed

2 files changed

+19
-13
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
![PyPI](https://img.shields.io/pypi/v/logstyles)
44
![License](https://img.shields.io/pypi/l/logstyles)
55
![Python Versions](https://img.shields.io/pypi/pyversions/logstyles)
6-
![Python CI](https://github.com/jaylann/logstyles/actions/workflows/python-app.yml/badge.svg)
6+
![Tests](https://github.com/jaylann/logstyles/actions/workflows/python-app.yml/badge.svg)
77

88

99
## 🌟 Introduction
@@ -91,18 +91,24 @@ You can customize the formatter by specifying different parameters:
9191

9292
### 🎨 Themes
9393

94-
- **Latte**
95-
- **Frappé**
96-
- **Macchiato**
97-
- **Mocha**
94+
- **Catpuccin Latte**
95+
- **Catpuccin Frappe**
96+
- **Catpuccin Macchiato**
97+
- **Catpuccin Mocha**
98+
- **Tokyo Night**
99+
- **Tokyo Night Storm**
98100
- **Tokyo Night Light**
99101

100102
### 📝 Formats
101103

102-
- **Simple**: Minimalist format showing only the message.
103-
- **Detailed**: Includes time, level, module, function, line number, and message.
104-
- **Threaded**: Adds thread information to the log.
105-
- **Process**: Includes process information in the log.
104+
| **Format** | **Example** |
105+
|------------------|---------------------------------------------------------------------------------------------------------------------------------|
106+
| **Simple** | `This is a DEBUG message.` |
107+
| **Detailed** | `2024-11-28 15:11:49 \| DEBUG \| main \| main \| 39 \| This is a DEBUG message.` |
108+
| **Threaded** | `2024-11-28 15:11:49 \| DEBUG \| MainThread \| This is a DEBUG message.` |
109+
| **Process** | `2024-11-28 15:11:49 \| DEBUG \| MainProcess \| This is a DEBUG message.` |
110+
| **Left Aligned** | `DEBUG : This is a DEBUG message.` |
111+
| **Column** | `2024-11-28 15:11:49 \| DEBUG \| main \| This is a DEBUG message.` |
106112

107113
## 🧪 Testing
108114

logstyles/themes.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@
101101
},
102102
},
103103
},
104-
'Latte': {
104+
'Catpuccin Latte': {
105105
'timestamp_format': '%Y-%m-%d %H:%M:%S',
106106
'time_color': '#9ca0b0', # Overlay0
107107
'module_color': '#df8e1d', # Yellow
@@ -133,7 +133,7 @@
133133
},
134134
},
135135
},
136-
'Frappe': {
136+
'Catpuccin Frappe': {
137137
'timestamp_format': '%Y-%m-%d %H:%M:%S',
138138
'time_color': '#737994', # Overlay0
139139
'module_color': '#e5c890', # Yellow
@@ -165,7 +165,7 @@
165165
},
166166
},
167167
},
168-
'Macchiato': {
168+
'Catpuccin Macchiato': {
169169
'timestamp_format': '%Y-%m-%d %H:%M:%S',
170170
'time_color': '#6e738d', # Overlay0
171171
'module_color': '#eed49f', # Yellow
@@ -197,7 +197,7 @@
197197
},
198198
},
199199
},
200-
'Mocha': {
200+
'Catpuccin Mocha': {
201201
'timestamp_format': '%Y-%m-%d %H:%M:%S',
202202
'time_color': '#6c7086', # Overlay0
203203
'module_color': '#f9e2af', # Yellow

0 commit comments

Comments
 (0)