Skip to content

Commit ff4f09e

Browse files
committed
+Update readme
1 parent 976e570 commit ff4f09e

File tree

2 files changed

+16
-17
lines changed

2 files changed

+16
-17
lines changed

_README_CONTENT.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
`df_log` is a massive upgrade from `print()`. It makes your console output beautiful, readable, and powerful, turning your logs into a central event bus for debugging, analytics, and crash reporting. It’s for the developer who wants the simplicity of `print()` but with more clarity, context, and control.
22

3+
4+
<img src="https://raw.githubusercontent.com/dev-cetera/df_log/main/doc/assets/screenshot2.png" alt="Visual Studio Code Terminal" width="600">
5+
36
## Features
47

58
- **Categorized Logging:** Pre-defined methods like `Log.info`, `Log.err`, `Log.ok` for semantic logging.
@@ -11,10 +14,6 @@
1114
- **IDE Integration:** Optionally uses `dart:developer`'s `log` function for a richer experience in some IDEs.
1215
- **Extensible:** Add custom callbacks to integrate with other services (e.g., crash reporting).
1316

14-
## Screenshot
15-
16-
<img src="https://raw.githubusercontent.com/dev-cetera/df_log/main/example/example.png" alt="Example image" width="400">
17-
1817
## 🚀 Getting Started
1918

2019
For an introduction, please refer to this article:
@@ -35,10 +34,10 @@ import 'package:df_log/df_log.dart';
3534
3635
void main() {
3736
Log.start('Application starting...');
38-
Log.info('This is an informational message.');
39-
Log.ok('User successfully authenticated.');
40-
Log.alert('Network connection is slow.');
41-
Log.err('Failed to load user data!');
37+
Log.info('Checking for user session...');
38+
Log.alert('Network connection is slow. Retrying in 5s.');
39+
Log.ok('User session found and validated.');
40+
Log.err('Failed to load user preferences!');
4241
Log.stop('Application shutting down.');
4342
}
4443
```
@@ -48,15 +47,15 @@ void main() {
4847
Colored logs enhance readability and help you quickly identify different types of messages in the console. By applying distinct colors, you can easily track errors, successes, warnings, and other log types at a glance.
4948

5049
```dart
51-
// If the Log class conflicts with another class, use an alias with as.
52-
import 'package:df_log/df_log.dart' as df;
53-
54-
void main() {
55-
df.Log.printRed('This is an important error.');
56-
df.Log.printGreen('Operation was successful.');
57-
df.Log.printYellow('This is a warning.');
58-
// and many more...
59-
}
50+
Log.printRed('This is printed in RED!');
51+
Log.printGreen('This is printed in GREEN!');
52+
Log.printBlue('This is printed in BLUE!');
53+
Log.printYellow('This is printed in YELLOW!');
54+
Log.printCyan('This is printed in CYAN!');
55+
Log.printPurple('This is printed in PURPLE!');
56+
Log.printBlack('This is printed in BLACK!');
57+
Log.printWhite('This is printed in WHITE!');
58+
// and many more...
6059
```
6160

6261
### 3. Tags

example/example.png

-257 KB
Binary file not shown.

0 commit comments

Comments
 (0)