Skip to content

Commit 9867081

Browse files
committed
Update README.md
Update funding config and improve README support section Corrected the Ko-fi key in FUNDING.yml. Refactored the README to clarify support options, improve FAQ answers, and reorganize contribution and support sections for better readability.
1 parent 1a8c356 commit 9867081

File tree

2 files changed

+18
-17
lines changed

2 files changed

+18
-17
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
github: vonhoff
2-
ko-fi: vonhoff
2+
ko_fi: vonhoff

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,9 @@ A [Serilog](https://github.com/serilog/serilog) sink that writes log events to a
1515
- Multiple theme presets with customization options
1616
- High-performance asynchronous processing
1717
- Line limit to control memory usage
18-
- Pretty printing of JSON objects
18+
- Support for pretty-printing of JSON objects
1919
- WCAG compliant color schemes based on the [Serilog WPF RichTextBox](https://github.com/serilog-contrib/serilog-sinks-richtextbox) sink.
2020

21-
> **Consider supporting the development of this project on Ko-fi!**
22-
>
23-
> Your support keeps this project alive. Even a small gesture means a lot.
24-
>
25-
> [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/vonhoff)
26-
2721
## Getting Started
2822

2923
Install the package from NuGet:
@@ -74,23 +68,30 @@ The themes based on the original sinks are slightly adjusted to be [WCAG complia
7468

7569
You can create your own custom themes by creating a new instance of the [Theme](Serilog.Sinks.RichTextBox.WinForms.Colored/Sinks/RichTextBoxForms/Themes/Theme.cs) class and passing it to the `RichTextBox` extension method. Look at the [existing themes](Serilog.Sinks.RichTextBox.WinForms.Colored/Sinks/RichTextBoxForms/Themes/ThemePresets.cs) for examples.
7670

77-
## Frequently Asked Questions
71+
## FAQ
7872

7973
### Why is the package name so long?
8074

81-
Shorter alternatives were already reserved in the NuGet registry, so a more descriptive name was needed for this implementation. The name is a bit long, but it makes it easier to find the package in the NuGet registry.
75+
Shorter alternatives were already reserved in NuGet. The descriptive name helps people find it more easily.
76+
77+
### Why a WinForms RichTextBox and not WPF?
78+
79+
This sink is designed for WinForms apps to avoid pulling in the WPF framework and its dependencies.
80+
81+
## Support the Project 💖
82+
83+
This project has been maintained since 2022 and is still under active development. If you find it useful, please consider supporting it. Your support will help keep the project alive and allow me to dedicate more time to making improvements. You can support it through:
8284

83-
### Why use a WinForms RichTextBox instead of a WPF RichTextBox?
85+
* [GitHub Sponsors](https://github.com/sponsors/vonhoff)
86+
* [Ko-fi](https://ko-fi.com/vonhoff)
8487

85-
This sink is specifically designed for WinForms applications to avoid the WPF framework. Using a WPF-based logging component would require adding the entire WPF framework with all its dependencies, greatly increasing the size of the application.
88+
Every contribution of any size helps sustain ongoing development.
8689

87-
## Support and Contribute
90+
## Contributing
8891

89-
If you find value in this project, there are several ways you can contribute:
92+
Contributions are welcome! Report issues, improve documentation, or submit pull requests.
9093

91-
- Give the [project](https://github.com/vonhoff/Serilog.Sinks.RichTextBox.WinForms.Colored) a star on GitHub ⭐
92-
- Support the project through [GitHub Sponsors](https://github.com/sponsors/vonhoff)
93-
- Improve docs, report bugs, or submit PRs (see [CONTRIBUTING.md](CONTRIBUTING.md))
94+
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
9495

9596
## License
9697

0 commit comments

Comments
 (0)