From 142fcd4fa25cd8c2f1da1323a66a85ca2b095ef5 Mon Sep 17 00:00:00 2001
From: Mikael Fangel <34864484+MikaelFangel@users.noreply.github.com>
Date: Mon, 3 Jun 2024 18:38:02 +0000
Subject: [PATCH] docs: fix spellings (#2)

* docs: add module docs for color and flavor

* readme: fix misspelling of Catppuccin

* readme: fix general misspellings

* doc: fix misspellings

* version: bump patch
---
 README.md                   | 8 ++++----
 lib/catppuccin/catppucin.ex | 2 +-
 lib/catppuccin/color.ex     | 8 ++++++--
 lib/catppuccin/flavor.ex    | 6 +++++-
 mix.exs                     | 2 +-
 5 files changed, 17 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index f5acd3a89..5024c6cd6 100644
--- a/README.md
+++ b/README.md
@@ -795,15 +795,15 @@
 
 ## Usage
 
-1. Inlcude the depencency in your mix project.
+1. Include the dependency in your mix project.
 ```elixir
 def deps do
   [
-    {:catppuccin, github: "MikaelFangel/elixir", tag: "v0.1.0"}
+    {:catppuccin, github: "MikaelFangel/elixir", tag: "v0.1.1"}
   ]
 end
 ```
-2. Enjoy the access to the beautifull catppuccin palette.
+2. Enjoy the beautiful Catppuccin palette.
 
 ## Examples 
 
@@ -824,7 +824,7 @@ Catppuccin.latte
 ### Get flavor emoji
 ```elixir
 Catppuccin.latte
-|> Catpuccin.Flavor.emoji
+|> Catppuccin.Flavor.emoji
 ```
 
 <!-- this section is optional -->
diff --git a/lib/catppuccin/catppucin.ex b/lib/catppuccin/catppucin.ex
index a3a8dabbd..aac815def 100644
--- a/lib/catppuccin/catppucin.ex
+++ b/lib/catppuccin/catppucin.ex
@@ -6,7 +6,7 @@ defmodule Catppuccin do
   alias Catppuccin.FlavorETS
 
   @doc """
-  Retuns the flavor data for the latte flavor.
+  Returns the flavor data for the latte flavor.
   """
   @spec latte() :: Flavor.t()
   def latte do
diff --git a/lib/catppuccin/color.ex b/lib/catppuccin/color.ex
index db476863d..9ed3fb18f 100644
--- a/lib/catppuccin/color.ex
+++ b/lib/catppuccin/color.ex
@@ -1,8 +1,12 @@
 defmodule Catppuccin.Color do
+  @moduledoc """
+  Module for handling color data.
+  """
+
   alias Catppuccin.Flavor
 
   @typedoc """
-  Datastructure representing a color i hex, rgb, and hsl.
+  Data structure representing a color i hex, rgb, and hsl.
   """
   @type t :: %__MODULE__{
           name: String.t(),
@@ -94,7 +98,7 @@ defmodule Catppuccin.Color do
   end
 
   @doc """
-  Retuns the color data for the rosewater color for a given flavor.
+  Returns the color data for the rosewater color for a given flavor.
 
   ## Examples
 
diff --git a/lib/catppuccin/flavor.ex b/lib/catppuccin/flavor.ex
index fe1b6ec21..d76aa53e8 100644
--- a/lib/catppuccin/flavor.ex
+++ b/lib/catppuccin/flavor.ex
@@ -1,6 +1,10 @@
 defmodule Catppuccin.Flavor do
+  @moduledoc """
+  Module to retrieve information about flavors.
+  """
+
   @typedoc """
-  Datastructure representing a flavor.
+  Data structure representing a flavor.
   """
   @type t :: %__MODULE__{
           name: String.t(),
diff --git a/mix.exs b/mix.exs
index 4e9281978..f143c1876 100644
--- a/mix.exs
+++ b/mix.exs
@@ -4,7 +4,7 @@ defmodule Catppuccin.MixProject do
   def project do
     [
       app: :catppuccin,
-      version: "0.1.0",
+      version: "0.1.1",
       elixir: "~> 1.15",
       start_permanent: Mix.env() == :prod,
       deps: deps(),