From 57756573c3cfb3bfa5d397ad915864c6e150d9aa Mon Sep 17 00:00:00 2001
From: c4710n <c4710n@users.noreply.github.com>
Date: Thu, 29 Aug 2024 15:09:45 +0800
Subject: [PATCH] docs: polish it

---
 README.md | 20 +++++++++++++-------
 mix.exs   |  3 +--
 2 files changed, 14 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index c0a0290..93823cf 100644
--- a/README.md
+++ b/README.md
@@ -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
 
diff --git a/mix.exs b/mix.exs
index e678791..ede53db 100644
--- a/mix.exs
+++ b/mix.exs
@@ -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
@@ -47,7 +47,6 @@ defmodule CozyLogger.MixProject do
   defp docs do
     [
       extras: ["README.md"],
-      main: "readme",
       source_url: @source_url,
       source_ref: "v#{@version}"
     ]