Skip to content

Commit

Permalink
Fix README + doc links
Browse files Browse the repository at this point in the history
  • Loading branch information
daningalla committed Sep 1, 2023
1 parent 811f076 commit 53717c3
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 51 deletions.
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,3 @@ logger.LogInformation("Hello world!");
## Documentation

Read the full [docs](https://github.com/verticalsoftware/vertical-spectreconsolelogger/blob/dev/docs/docs-home.md) here.


## Examples

Checkout and run our [examples](https://github.com/verticalsoftware/vertical-spectreconsolelogger/tree/dev/examples) to see the logger in action.
62 changes: 16 additions & 46 deletions docs/docs-home.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,6 @@

A seriously customizable [Spectre Console](https://spectreconsole.net/) provider for Microsoft.Extensions.Logging. **Don't** change how your app logs - change how the logs are presented.

![.net](https://img.shields.io/badge/Frameworks-.netstandard2.0+net6/7-purple)
![GitHub](https://img.shields.io/github/license/verticalsoftware/vertical-commandline)
![Package info](https://img.shields.io/nuget/v/vertical-spectreconsolelogger.svg)

[![Dev build](https://github.com/verticalsoftware/vertical-commandline/actions/workflows/dev-build.yml/badge.svg)](https://github.com/verticalsoftware/vertical-commandline/actions/workflows/dev-build.yml)
[![codecov](https://codecov.io/gh/verticalsoftware/vertical-spectreconsolelogger/branch/dev/graph/badge.svg?token=MVW0CUWLCW)](https://codecov.io/gh/verticalsoftware/vertical-spectreconsolelogger)
[![Pre release](https://github.com/verticalsoftware/vertical-spectreconsolelogger/actions/workflows/pre-release.yml/badge.svg)](https://github.com/verticalsoftware/vertical-spectreconsolelogger/actions/workflows/pre-release.yml)
[![Release](https://github.com/verticalsoftware/vertical-spectreconsolelogger/actions/workflows/release.yml/badge.svg)](https://github.com/verticalsoftware/vertical-spectreconsolelogger/actions/workflows/release.yml)

## Quick Start

Add a package reference to your `.csproj` file:
Expand All @@ -30,48 +21,27 @@ var logger = loggerFactory.CreateLogger("MyLogger");
logger.LogInformation("Hello world!");
```

## Features at a glance

1. Decouples styling and formatting from logging (e.g. don't change your logging, customize how the events are displayed).
2. Define different customizations for _each_ log level.
3. Customize the styling and formatting of specific values or specific types of values.
4. Destructure and output complex types in JSON(ish) notation.
5. Customize the rendering completely using output templates.
6. Extend the logger with your own renderers.

#### Format/style log values

![cap-1](https://raw.githubusercontent.com/verticalsoftware/vertical-spectreconsolelogger/dev/assets/cap1.png)

#### Destructured output follows configuration

![cap-2](https://raw.githubusercontent.com/verticalsoftware/vertical-spectreconsolelogger/dev/assets/cap2.png)

#### Precisely control exception output

![cap-3](https://raw.githubusercontent.com/verticalsoftware/vertical-spectreconsolelogger/dev/assets/cap3.png)

## Documentation

- Introductory Topics
- [Basic Configuration](docs/basic-configuration.md)
- [Output Templates](docs/output-template.md)
- [Formatting Log Values](docs/formatting.md)
- [Styling Log Values](docs/styling.md)
- [Destructured Output](docs/destructuring.md)
- [Basic Configuration](basic-configuration.md)
- [Output Templates](output-template.md)
- [Formatting Log Values](formatting.md)
- [Styling Log Values](styling.md)
- [Destructured Output](destructuring.md)
- Output Renderers
- [Renderers Overview](docs/renderer-overview.md)
- [ActivityId](docs/activity-id.md)
- [CategoryName](docs/category-name.md)
- [DateTime](docs/date-time.md)
- [Exception](docs/exceptions.md)
- [MarginControl](docs/margin-control.md)
- [NewLine](docs/newline.md)
- [Scope](docs/scope-value.md)
- [Scopes](docs/scopes-value)
- [ThreadId](docs/thread-id.md)
- [Renderers Overview](renderer-overview.md)
- [ActivityId](activity-id.md)
- [CategoryName](category-name.md)
- [DateTime](date-time.md)
- [Exception](exceptions.md)
- [MarginControl](margin-control.md)
- [NewLine](newline.md)
- [Scope](scope-value.md)
- [Scopes](scopes-value)
- [ThreadId](thread-id.md)
- Advanced Topics
- [Advanced Configuration](docs/advanced-config.md)
- [Advanced Configuration](advanced-config.md)
- API
- Browse assembly documentation on [Tripleslash.io](https://tripleslash.io/docs/.net/vertical-spectreconsolelogger/0.10.1-dev.20230712.19/api/@index?view=net7.0)

Expand Down

0 comments on commit 53717c3

Please sign in to comment.