From 314852c9f4c095b60830a2a0ec9ca64701406c9b Mon Sep 17 00:00:00 2001 From: Shahryar Tavakkoli Date: Sat, 29 Jun 2024 08:38:44 +0330 Subject: [PATCH] VIP - Improve Main docs --- README.md | 19 +++++++++++++------ lib/mishka_installer.ex | 19 +++++++++++++------ 2 files changed, 26 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 627b3ea..4da40ab 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,10 @@ and now they need to activate a section for registration and `SMS`; the system a present your desired input/output absolutely plugin oriented to your users and makes it possible for the developers to write their required applications beyond the core source code. -**NOTICE: Do not use the master branch; this library is under heavy development. Expect version 0.1.0, -and for using the new features, please wait until a new release is out.** + +> **NOTICE**: Do not use the master branch; this library is under heavy development. +> Expect version 0.1.0, and for using the new features, please wait until a new release is out. + ##### This library is divided into the following main sections: @@ -38,7 +40,7 @@ In **Mishka Installer** Library, a series of action or hook functions are given to the developer of the main plugin or software, which helps build plugins outside/inside the system and convert software sections into separate events. -Some of the functions of this module include the following: +**Some of the functions of this module include the following:** - Retrieves the merged configuration for the hook module. - Register a plugin for a specific event. @@ -63,7 +65,7 @@ defmodule RegisterEmailSender do end ``` -If you want to change a series of default information, do this: +**If you want to change a series of default information, do this:** ```elixir use MishkaInstaller.Event.Hook, @@ -71,7 +73,7 @@ use MishkaInstaller.Event.Hook, initial: %{depends: [SomeEvent], priority: 20} ``` -#### You can call all plugins of an event: +**You can call all plugins of an event:** ```elixir alias MishkaInstaller.Event.Hook @@ -106,6 +108,7 @@ Supervisor.start_link(children, opts) ### Plugin management system theory and installation of Elixir libraries at runtime --- + The functionality of this library can be conceptualized as an architectural potential that is composed of two primary components, which are as follows: @@ -147,7 +150,11 @@ Installer.async_install(%__MODULE__{app: "some_name", path: "some_name", type: : ## Installing the library: --- -It should be noted that this library must be installed in two parts of the plugin and the software that wants to display the plugins, and due to its small dependencies, it does not cause any problems. To install, just add this library to your "mix.exs" in the "deps" function as follows: + +It should be noted that this library must be installed in two parts of the plugin and the +software that wants to display the plugins, and due to its small dependencies, it does +not cause any problems. To install, just add this library to your "mix.exs" in the "deps" +function as follows: ```elixir def deps do diff --git a/lib/mishka_installer.ex b/lib/mishka_installer.ex index 184056d..34bbf34 100644 --- a/lib/mishka_installer.ex +++ b/lib/mishka_installer.ex @@ -14,8 +14,10 @@ defmodule MishkaInstaller do present your desired input/output absolutely plugin oriented to your users and makes it possible for the developers to write their required applications beyond the core source code. - **NOTICE: Do not use the master branch; this library is under heavy development. Expect version 0.1.0, - and for using the new features, please wait until a new release is out.** + + > **NOTICE**: Do not use the master branch; this library is under heavy development. + > Expect version 0.1.0, and for using the new features, please wait until a new release is out. + ##### This library is divided into the following main sections: @@ -40,7 +42,7 @@ defmodule MishkaInstaller do given to the developer of the main plugin or software, which helps build plugins outside/inside the system and convert software sections into separate events. - Some of the functions of this module include the following: + **Some of the functions of this module include the following:** - Retrieves the merged configuration for the hook module. - Register a plugin for a specific event. @@ -65,7 +67,7 @@ defmodule MishkaInstaller do end ``` - If you want to change a series of default information, do this: + **If you want to change a series of default information, do this:** ```elixir use MishkaInstaller.Event.Hook, @@ -73,7 +75,7 @@ defmodule MishkaInstaller do initial: %{depends: [SomeEvent], priority: 20} ``` - #### You can call all plugins of an event: + **You can call all plugins of an event:** ```elixir alias MishkaInstaller.Event.Hook @@ -108,6 +110,7 @@ defmodule MishkaInstaller do ### Plugin management system theory and installation of Elixir libraries at runtime --- + The functionality of this library can be conceptualized as an architectural potential that is composed of two primary components, which are as follows: @@ -149,7 +152,11 @@ defmodule MishkaInstaller do ## Installing the library: --- - It should be noted that this library must be installed in two parts of the plugin and the software that wants to display the plugins, and due to its small dependencies, it does not cause any problems. To install, just add this library to your "mix.exs" in the "deps" function as follows: + + It should be noted that this library must be installed in two parts of the plugin and the + software that wants to display the plugins, and due to its small dependencies, it does + not cause any problems. To install, just add this library to your "mix.exs" in the "deps" + function as follows: ```elixir def deps do