Skip to content

Commit 83a5d97

Browse files
committed
Miscellaneous minor updates to docs and package info
1 parent 35dd599 commit 83a5d97

30 files changed

+176
-159
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023 Second Bounce Ltd
3+
Copyright (c) 2023-24 Second Bounce Ltd
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,37 +6,32 @@
66
log4ngx is a Typescript logging framework for Angular projects, based on concepts used in Log4j,
77
Log4net, etc.
88

9-
> **Current Status**
10-
> The library is now complete enough to be used in production if the `ConsoleAppender` and
11-
`LocalStorageAppender` are sufficient for your needs. Documentation is being completed in the
12-
repository and will be updated as progress is made - as soon as it is in a reasonably complete
13-
state, a proper link will be made available here.
14-
>
15-
> Until then, the [demo project](tree/main/projects/demo/) contains examples of configuring and
16-
using the library.
17-
189
## Concepts
1910

11+
### Loggers
12+
13+
`Loggers` provide access to the methods for logging messages at the required `Level`. Each class -
14+
i.e. component, module or service - will usually define its own `Logger` which will identify that
15+
class within any messages logged via it.
16+
2017
### LogService
2118

2219
The `LogService` is the factory with which you instantiate `Loggers` in each of the components,
2320
services, etc, in which you wish to log messages. Behind the scenes, it also orchestrates the
2421
dispatch of messages from the `Loggers` to the appropriate `Appenders`.
2522

23+
### Appenders
24+
25+
`Appenders` are responsible for sending log entries to the underlying target or service.
26+
Configuration will normally depend on the target/service, but all `Appenders` are configured with
27+
the layout format for messages logged to them.
28+
2629
### LogServiceConfig
2730

2831
The `LogService` is configured using an instance of the `LogServiceConfig`, typically created in
2932
your application's main module. The configuration defines the parameters used with each `Appender`
3033
and how each `Appender` relates to the various `Loggers`.
3134

32-
### Loggers
33-
34-
`Loggers` provide access to the methods for logging messages at the required `Level`. Each class -
35-
i.e. component, module or service - will usually define its own `Logger` which will identify that
36-
class within any messages logged via it.
37-
38-
### Appenders
39-
40-
`Appenders` are responsible for sending log entries to the underlying target or service.
41-
Configuration will normally depend on the target/service, but all `Appenders` are configured with
42-
the layout format for messages logged to them.
35+
For more information about using and configuring log4ngx, see <https://secondbounce.github.io/log4ngx/>.
36+
The [demo project](projects/demo/) also contains examples of configuring and using the
37+
library.

docs/assets/navigation.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)