Skip to content

Commit

Permalink
VIP - Improve Main docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shahryarjb committed Jun 29, 2024
1 parent a23b65a commit 314852c
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 12 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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.
Expand All @@ -63,15 +65,15 @@ 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,
event: "after_success_login",
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
Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down
19 changes: 13 additions & 6 deletions lib/mishka_installer.ex
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
Expand All @@ -65,15 +67,15 @@ 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,
event: "after_success_login",
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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 314852c

Please sign in to comment.