Skip to content

Commit c92997f

Browse files
committed
Reformat markdown headers in README.md
As mentioned in #131.
1 parent 4625f8c commit c92997f

File tree

1 file changed

+10
-20
lines changed

1 file changed

+10
-20
lines changed

README.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Log formatting with colors!
2-
===========================
1+
# Log formatting with colors!
32

43
[![](https://img.shields.io/pypi/v/colorlog.svg)](https://pypi.org/project/colorlog/)
54
[![](https://img.shields.io/pypi/l/colorlog.svg)](https://pypi.org/project/colorlog/)
@@ -9,8 +8,7 @@ Add colours to the output of Python's `logging` module.
98
* [Source on GitHub](https://github.com/borntyping/python-colorlog)
109
* [Packages on PyPI](https://pypi.org/pypi/colorlog/)
1110

12-
Status
13-
------
11+
## Status
1412

1513
colorlog currently requires Python 3.6 or higher. Older versions (below 5.x.x)
1614
support Python 2.6 and above.
@@ -30,8 +28,7 @@ requests. colorlog 4 might accept essential bugfixes but should not be
3028
considered actively maintained and will not accept any major changes or new
3129
features.
3230

33-
Installation
34-
------------
31+
## Installation
3532

3633
Install from PyPI with:
3734

@@ -43,8 +40,7 @@ Several Linux distributions provide official packages ([Debian], [Arch], [Fedora
4340
[Gentoo], [OpenSuse] and [Ubuntu]), and others have user provided packages
4441
([BSD ports], [Conda]).
4542

46-
Usage
47-
-----
43+
## Usage
4844

4945
```python
5046
import colorlog
@@ -107,8 +103,7 @@ support for these varies wildly across different terminals.
107103
- `light_cyan`
108104
- `light_white`
109105

110-
Examples
111-
--------
106+
## Examples
112107

113108
![Example output](doc/example.png)
114109

@@ -211,37 +206,32 @@ logger.setLevel('TRACE')
211206
logger.log(TRACE, 'a message using a custom level')
212207
```
213208

214-
Tests
215-
-----
209+
## Tests
216210

217211
Tests similar to the above examples are found in `tests/test_colorlog.py`.
218212

219-
Status
220-
------
213+
## Status
221214

222215
colorlog is in maintenance mode. I try and ensure bugfixes are published,
223216
but compatibility with Python 2.6+ and Python 3+ makes this a difficult
224217
codebase to add features to. Any changes that might break backwards
225218
compatibility for existing users will not be considered.
226219

227-
Alternatives
228-
------------
220+
## Alternatives
229221

230222
There are some more modern libraries for improving Python logging you may
231223
find useful.
232224

233225
- [structlog]
234226
- [jsonlog]
235227

236-
Projects using colorlog
237-
-----------------------
228+
## Projects using colorlog
238229

239230
GitHub provides [a list of projects that depend on colorlog][dependents].
240231

241232
Some early adopters included [Errbot], [Pythran], and [zenlog].
242233

243-
Licence
244-
-------
234+
## Licence
245235

246236
Copyright (c) 2012-2021 Sam Clements <sam@borntyping.co.uk>
247237

0 commit comments

Comments
 (0)