mirror
/
logrus
mirror of https://github.com/sirupsen/logrus.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

readme: clarify casing issues further

This commit is contained in:
Simon Eskildsen 2017-06-29 20:54:20 -04:00
parent 3d4380f53a
commit 7dd06bf38e
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -3,13 +3,14 @@
Logrus is a structured logger for Go (golang), completely API compatible with Logrus is a structured logger for Go (golang), completely API compatible with
the standard library logger. [Godoc][godoc]. the standard library logger. [Godoc][godoc].
**Seeing weird case-sensitive problems?** Unfortunately, the author failed to **Seeing weird case-sensitive problems?** It's in the past been possible to
realize the consequences of renaming to lower-case. Due to the Go package import Logrus as both upper- and lower-case. Due to the Go package environment,
environment, this caused issues. Regretfully, there's no turning back now. this caused issues in the community and we needed a standard. Some environments
experienced problems with the upper-case variant, so the lower-case was decided.
Everything using `logrus` will need to use the lower-case: Everything using `logrus` will need to use the lower-case:
`github.com/sirupsen/logrus`. Any package that isn't, should be changed. `github.com/sirupsen/logrus`. Any package that isn't, should be changed.
I am terribly sorry for this inconvenience. Logrus strives hard for backwards **I am terribly sorry for this inconvenience.** Logrus strives hard for backwards
compatibility, and the author failed to realize the cascading consequences of compatibility, and the author failed to realize the cascading consequences of
such a name-change. To fix Glide, see [these such a name-change. To fix Glide, see [these
comments](https://github.com/sirupsen/logrus/issues/553#issuecomment-306591437). comments](https://github.com/sirupsen/logrus/issues/553#issuecomment-306591437).