Skip to content

Commit

Permalink
docs: polish it
Browse files Browse the repository at this point in the history
  • Loading branch information
c4710n committed Aug 29, 2024
1 parent ab9c427 commit 5775657
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,27 @@

<!-- MDOC -->

Logging helpers, providing format functions of various formats and seamless integrations with other libraries.
Logger helpers, providing format functions of various formats and seamless integrations with other libraries.

## Features

- Formats
- [x] JSON
- ...
- JSON
- Integrations
- [x] Phoenix
- [ ] Ecto
- ...
- Phoenix
- Oban

## Installation

[Install it from Hex](https://hex.pm/packages/cozy_logger).
Add `:package_name` to the list of dependencies in `mix.exs`:

```elixir
def deps do
[
{:cozy_logger, <requirement>}
]
end
```

## Usage

Expand Down
3 changes: 1 addition & 2 deletions mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ defmodule CozyLogger.MixProject do
use Mix.Project

@version "1.0.1"
@description "Logging helpers, providing format functions of various formats and seamless integrations with other libraries."
@description "Logger helpers, providing format functions of various formats and seamless integrations with other libraries."
@source_url "https://github.com/cozy-elixir/cozy_logger"

def project do
Expand Down Expand Up @@ -47,7 +47,6 @@ defmodule CozyLogger.MixProject do
defp docs do
[
extras: ["README.md"],
main: "readme",
source_url: @source_url,
source_ref: "v#{@version}"
]
Expand Down

0 comments on commit 5775657

Please sign in to comment.