BCUtils.Banner (bc_utils v0.6.0)

Provides functionality to display a startup banner.

Summary

Functions

display_banner(service_name, service_description, shoutout, beam_theme_func \\ &sky_blue_on_true_black/1, campus_theme_func \\ &lime_on_true_black/1, description_theme_func \\ &indigo_on_true_black/1)

@spec display_banner(
  service_name :: String.t(),
  service_description :: String.t(),
  shoutout :: String.t(),
  beam_theme_func :: (String.t() -> String.t()),
  campus_theme_func :: (String.t() -> String.t()),
  description_theme_func :: (String.t() -> String.t())
) :: :ok

display_text_banner(service_name, service_description, shoutout, beam_theme_func \\ &sky_blue_on_true_black/1, campus_theme_func \\ &lime_on_true_black/1, description_theme_func \\ &purple_on_true_black/1)

@spec display_text_banner(
  service_name :: String.t(),
  service_description :: String.t(),
  shoutout :: String.t(),
  beam_theme_func :: (String.t() -> String.t()),
  campus_theme_func :: (String.t() -> String.t()),
  description_theme_func :: (String.t() -> String.t())
) :: :ok

Displays a BEAM Campus flavored, emoji-enabled startup banner. ## Parameters

* service_name - The name of the service

* service_description - A short description of the service

* shoutout - A shoutout to the BEAM Campus

## Tip

* You can use BCUtils.ColorFuncs to colorize name, description and shoutout.

* Add an emoji to the shoutout for extra fun