diff --git a/README.md b/README.md index f2a2667..98400da 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # `EventLoggerRails` -🎉 **Welcome to EventLoggerRails: Your Event Logging Sidekick!** 🎉 +## 🎉 **Enter the EventLoggerRails Dimension: Your Companion in the Chronicle of Events!** 🎉 Are you tired of navigating through logs as if you're lost in the labyrinth of the Wired, searching for that elusive piece of data? Say "Hello, World!" to `EventLoggerRails`, the Rails engine that turns your logs into a treasure trove of insights! 🌟 -## Picture This +### Visualize This -With a straightforward and centralized config file, you can easily define all the events that make your business tick. Then watch as `EventLoggerRails` transforms these events into dazzling JSON logs! 🎇 +In a single, centralized config file, decipher the events that pulse through the veins of your business. Once set, let `EventLoggerRails` weave them into intricate patterns of JSON logs that shimmer like a digital mirage. 🎇 -## But Wait, There's More! +### Yet, The Nexus Expands -Seamlessly funnel these JSON marvels into analytics platforms like OpenSearch, and behold the magic of data visualization and real-time analysis. 📊✨ +Channel these JSON enigmas directly into analytic realms like OpenSearch. There, witness the alchemy of data taking form through real-time visualizations and analysis. 📊✨ -## Why Choose `EventLoggerRails`? +### Why Choose `EventLoggerRails`? - 🚀 **Fast Setup**: Get your logging up and running in minutes, not hours! - 🌐 **Team-Friendly Event Registry**: Simplify how your team defines and logs business-critical events. @@ -23,8 +23,8 @@ Don't let crucial events get lost in the digital void. Make your app's logging a ## Usage -You can define a registry of events that your application emits via the config file (`config/event_logger_rails.yml`). -The events that you define are placed in the `registered_events` structure in the config file. +You can define a registry of events your application emits via the config file (`config/event_logger_rails.yml`). +The events you define are placed in the `registered_events` structure in the config file. For example, to register a user signup event, first define the event as a registered event: @@ -179,7 +179,7 @@ class User < ApplicationRecord end ``` -By default, `event_logger_rails` will include the model name and instance ID, along with whatever data is passed. +By default, `event_logger_rails` will include the model name, instance ID, and whatever data is passed. ```json { @@ -305,7 +305,7 @@ bin/rails generate event_logger_rails:install Add your events to the generated config file following the structure of the examples. By default, `event_logger_rails` outputs to a separate log file (`log/event_logger_rails.#{Rails.env}.log`) from normal Rails log output, allowing -you to ingest these logs independently. If you wish to set an alternative log device to capture output , you can configure it in `config/application.rb`: +you to ingest these logs independently. If you wish to set an alternative log device to capture output, you can configure it in `config/application.rb`: ```ruby Rails.application.configure do |config| @@ -315,7 +315,7 @@ end ## Contributing -Contributions are welcome. Feel free to open a PR. +Your inputs echo in this realm. Venture forth and materialize your thoughts through a PR. ## License