TheThing/node-bunyan-lite
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Wiki Activity

README updates for current status (master for 2.x work now), some TODO updates

Browse source
This commit is contained in:
Trent Mick 2017-04-15 18:07:58 -07:00
parent 13c86f1d15
commit f812975f0f
2 changed files with 17 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -64,16 +64,20 @@ record (see below).
# Current Status # Current Status
Solid core functionality is there. Joyent is using this for a number of Stable. I do my best to follow semver: i.e. you should only need to worry
production services. Bunyan supports node 0.10 and greater. Follow about code breaking for a *major* version bump. Bunyan currently supports node
<a href="https://twitter.com/intent/user?screen_name=trentmick" target="_blank">@trentmick</a> 0.10 and greater. Follow <a href="https://twitter.com/intent/user?screen_name=trentmick"
for updates to Bunyan. target="_blank">@trentmick</a> for updates to Bunyan.
There is an email discussion list There is an email discussion list
[bunyan-logging@googlegroups.com](mailto:bunyan-logging@googlegroups.com), [bunyan-logging@googlegroups.com](mailto:bunyan-logging@googlegroups.com),
also [as a forum in the also [as a forum in the
browser](https://groups.google.com/forum/?fromgroups#!forum/bunyan-logging). browser](https://groups.google.com/forum/?fromgroups#!forum/bunyan-logging).
Active branches:
- "master" is currently for coming Bunyan 2.x work.
- "1.x" is for 1.x maintenance work, if any.
# Installation # Installation

18
TODO.md
View file

@ -1,13 +1,7 @@
# higher prio
- `bunyan` (without redir) ^C should stop, doesn't since recent change
- man page for the bunyan CLI (refer to it in the readme)
- perhaps wait for a bunyan new version with deps, and use dashdash
with a (vapour) man page generator
# v2 # v2
- ^C fix - ^C fix. Done in 1.8.9. However, see a recent ticket about ^C/EPIPE issues.
I suspect the uncommited exeunt work will fix that.
- node-exeunt - node-exeunt
- `createLogger(<config-and-fields>, <fields>)` changes (#460) - `createLogger(<config-and-fields>, <fields>)` changes (#460)
- see section below - see section below
@ -55,7 +49,7 @@ That's not too bad. It is clearer at least than:
TODO: TODO:
- is there a ticket for this work already? - is there a ticket for this work already? #460
- make the change - make the change
- do a migration guide? i.e. provide the grep commands to find all - do a migration guide? i.e. provide the grep commands to find all
possible calls to inspect. E.g. if don't have `rg logUndefined` in your possible calls to inspect. E.g. if don't have `rg logUndefined` in your
@ -64,6 +58,12 @@ TODO:
- list of issues/pulls that wanted to add new config fields - list of issues/pulls that wanted to add new config fields
# higher prio
- man page for the bunyan CLI (refer to it in the readme)
- perhaps wait for a bunyan new version with deps, and use dashdash
with a (vapour) man page generator
# docs # docs