chore: small readme improvements

open-feature · Jul 29, 2024 · a5e2169 · a5e2169
1 parent 147ea8a
commit a5e2169
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,7 @@
-[![Hex Version](https://img.shields.io/hexpm/v/open_feature.svg)](https://hex.pm/packages/open_feature) [![Hex Docs](https://img.shields.io/badge/docs-hexpm-blue.svg)](https://hexdocs.pm/open_feature/)
+[![Version](https://img.shields.io/hexpm/v/open_feature.svg)](https://hex.pm/packages/open_feature)
+[![Docs](https://img.shields.io/badge/docs-hexpm-blue.svg)](https://hexdocs.pm/open_feature/)
+[![License](https://img.shields.io/hexpm/l/req.svg)](https://github.com/ejscunha/elixir-open-feature-sdk/blob/main/LICENSE.md)
+[![CI](https://github.com/ejscunha/elixir-open-feature-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/ejscunha/elixir-open-feature-sdk/actions/workflows/ci.yml)
 
 <!-- markdownlint-disable MD033 -->
 <p align="center">
@@ -38,7 +41,7 @@ end
 
 ## 📓 Usage
 
-``` elixir
+```elixir
 provider = %OpenFeature.Provider.InMemory{
   flags: %{
     "flag_key" => %{

diff --git a/mix.exs b/mix.exs
@@ -39,7 +39,7 @@ defmodule OpenFeature.MixProject do
   end
 
   defp docs do
-    [main: "OpenFeature", extras: ["README.md", "LICENSE"]]
+    [main: "readme", extras: ["README.md", "LICENSE"]]
   end
 
   defp package do