Skip to content

Commit

Permalink
Miscellaneous minor updates to docs and package info
Browse files Browse the repository at this point in the history
  • Loading branch information
davidgeary committed Dec 11, 2024
1 parent 35dd599 commit 83a5d97
Show file tree
Hide file tree
Showing 30 changed files with 176 additions and 159 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 Second Bounce Ltd
Copyright (c) 2023-24 Second Bounce Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
35 changes: 15 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,37 +6,32 @@
log4ngx is a Typescript logging framework for Angular projects, based on concepts used in Log4j,
Log4net, etc.

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

## Concepts

### Loggers

`Loggers` provide access to the methods for logging messages at the required `Level`. Each class -
i.e. component, module or service - will usually define its own `Logger` which will identify that
class within any messages logged via it.

### LogService

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

### Appenders

`Appenders` are responsible for sending log entries to the underlying target or service.
Configuration will normally depend on the target/service, but all `Appenders` are configured with
the layout format for messages logged to them.

### LogServiceConfig

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

### Loggers

`Loggers` provide access to the methods for logging messages at the required `Level`. Each class -
i.e. component, module or service - will usually define its own `Logger` which will identify that
class within any messages logged via it.

### Appenders

`Appenders` are responsible for sending log entries to the underlying target or service.
Configuration will normally depend on the target/service, but all `Appenders` are configured with
the layout format for messages logged to them.
For more information about using and configuring log4ngx, see <https://secondbounce.github.io/log4ngx/>.
The [demo project](projects/demo/) also contains examples of configuring and using the
library.
2 changes: 1 addition & 1 deletion docs/assets/navigation.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/assets/search.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 83a5d97

Please sign in to comment.