halua 0.0.5 → 1.0.0

package/README.md

@@ -1,85 +1,15 @@
-# halua
-logger for JS/TS projects (mainly for browser, but logging handler could be replaced with your implementation). inspired by https://pkg.go.dev/log/slog
+# Halua
 
-### insallation
-```
-pnpm i halua
-// or 
-npm i halua
-// or
-yarn i halua
-```
-
-### calling signature
-works for .debug, .info, .warn, .err
-```typescript
-import { halua } from 'halua'
-
-halua.debug('message', 'count', 2, 'some other info', true)
-// output:
-// {timestamp} {logging level} message count="2" some other info="true"
-// 00/00/00 00:00:00 DEBUG message count="2" some other info="true"
-```
-the logging func accepts string as a message for the first argument, the following argumets are [key, value] to append 
-to a total log 
-
-### creating new instances
-```typescript
-import { halua } from 'halua'
-
-// create new instance
-let logger = halua.New()
-
-// create new instance with postfix, this method will inherit dateGetter and handler 
-logger = halua.With('operation')
-// will log as "{date} {level} {msg} {...args} operation"
-```
+Package that takes control of logging, metrics and other stuff.
 
-### controlling logging level
-```typescript
-import { halua, Level } from 'halua'
+Supports Text, JSON, Console handlers as output. Custom handlers can be easily created and used.
 
-const logger = halua.New(null, { minLevel: Level.Warn })
-// now logger won't output .debug and .info logs
-// Levels sequence: Debug, Info, Warn, Error
-```
-
-### replacing logging with custom handler
-The resulting log string will be sent to handler's method
-```typescript
-import { Handler, halua } from 'halua'
-
-class CustomHandler implements Handler {
-  debug(msg: string) {}
-  info(msg: string) {}
-  warn(msg: string) {}
-  error(msg: string) {}
-}
-
-// handler is replaced for current and future instances 
-halua.setHandler(CustomHandler)
-```
+### documentation
 
-### replacing date getter
-```typescript
-import { halua } from 'halua'
+There is a short doc [Tour of Halua](./docs/tour_of_halua.md) - it describes basic concepts
 
-halua.setDateGetter(() => performance.now())
-// will output performance stamp instead of Date (for this and future instances)
-```
-
-### using basic logging
-```typescript
-import { halua } from 'halua'
-
-// debug level 
-halua.debug('debug message')
-// info level 
-halua.info('info message')
+### installation
 
-// warning level
-halua.warn('warning')
-// error level
-halua.err('err message')
+```text
+npm i halua
 ```
-