docs: Small docs fixes

Author: rafaeelaudibert

README.md

@@ -147,7 +147,7 @@ You can disable PostHog tracking by setting `enabled_capture: false` in your con
 
 When `enabled_capture` is set to `false`:
 
-- All `Posthog.capture/3` and `Posthog.batch/3` calls will succeed silently
+- All `Posthog.capture/3` and `Posthog.batch/2` calls will succeed silently
 - PostHog will still communicate with the server for Feature Flags
 
 This is useful for:
@@ -355,4 +355,4 @@ When contributing to this project, please ensure your code passes all the develo
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.

lib/posthog.ex

@@ -31,7 +31,7 @@ defmodule Posthog do
   to send actual events to PostHog.
 
   When `enabled_capture` is set to `false`:
-  - All `Posthog.capture/3` and `Posthog.batch/3` calls will succeed silently
+  - All `Posthog.capture/3` and `Posthog.batch/2` calls will succeed silently
   - PostHog will still communicate with the server for Feature Flags
 
   This is useful for:

lib/posthog/application.ex

@@ -1,12 +1,80 @@
 defmodule Posthog.Application do
-  @moduledoc false
+  @moduledoc """
+  The main application module for PostHog Elixir client.
+
+  This module handles the application lifecycle and supervises the necessary processes
+  for the PostHog client to function properly. It primarily manages the Cachex instance
+  used for feature flag event deduplication.
+
+  ## Features
+
+  * Validates configuration before starting
+  * Manages a Cachex instance for feature flag event deduplication
+  * Implements LRU (Least Recently Used) caching strategy
+  * Automatically prunes cache entries to maintain size limits
+
+  ## Cache Configuration
+
+  The Cachex instance is configured with:
+  * Maximum of 50,000 entries (matching posthog-python's limit)
+  * LRU (Least Recently Used) eviction policy
+  * Automatic pruning every 10 seconds
+  * Access tracking for LRU implementation
+
+  ## Usage
+
+  The application is automatically started by the Elixir runtime when included
+  in your application's supervision tree. You don't need to start it manually.
+
+  To access the cache name in your code:
+
+      Posthog.Application.cache_name()
+      # Returns: :posthog_feature_flag_cache
+  """
 
   use Application
   import Cachex.Spec
 
   @cache_name :posthog_feature_flag_cache
+
+  @doc """
+  Returns the name of the Cachex instance used for feature flag event deduplication.
+
+  ## Returns
+
+    * `atom()` - The cache name, always `:posthog_feature_flag_cache` at the moment
+
+  ## Examples
+
+      iex> Posthog.Application.cache_name()
+      :posthog_feature_flag_cache
+  """
   def cache_name, do: @cache_name
 
+  @doc """
+  Starts the PostHog application.
+
+  This callback is called by the Elixir runtime when the application starts.
+  It performs the following tasks:
+  1. Validates the PostHog configuration
+  2. Sets up the Cachex instance for feature flag event deduplication
+  3. Starts the supervision tree
+
+  ## Parameters
+
+    * `_type` - The type of start (ignored)
+    * `args` - Keyword list of arguments, can include:
+
+  ## Returns
+
+    * `{:ok, pid()}` on successful start
+    * `{:error, term()}` on failure
+
+  ## Examples
+
+      # Start with default configuration
+      Posthog.Application.start(:normal, [])
+  """
   def start(_type, args) do
     # Validate configuration before starting
     Posthog.Config.validate_config!()