Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
programminghoch10 committed Aug 26, 2023
1 parent 19b3bb4 commit e317f41
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
Magisk-only completely systemless adblocking.

[![GitHub Latest Release (by date)](https://img.shields.io/github/v/release/programminghoch10/MagicalProtection?label=latest&logo=github&display_name=release)](https://github.com/programminghoch10/MagicalProtection/releases/latest)
[![GitHub Latest Release Date](https://img.shields.io/github/release-date/programminghoch10/MagicalProtection?logo=github)](https://github.com/programminghoch10/MagicalProtection/releases/latest) \
[![GitHub Automatic Update Workflow Status](https://img.shields.io/github/actions/workflow/status/programminghoch10/MagicalProtection/autoupdate.yml?logo=github%20actions&logoColor=white&label=autoupdate)](https://github.com/programminghoch10/MagicalProtection/actions/workflows/autoupdate.yml) \
[![GitHub Global Download Counter](https://img.shields.io/github/downloads/programminghoch10/MagicalProtection/total?logo=github)](https://github.com/programminghoch10/MagicalProtection/releases)
[![GitHub Latest Download Counter](https://img.shields.io/github/downloads/programminghoch10/MagicalProtection/latest/total?logo=github)](https://github.com/programminghoch10/MagicalProtection/releases/latest) \
[![GitHub Build Workflow Status](https://img.shields.io/github/actions/workflow/status/programminghoch10/MagicalProtection/build.yml?logo=github%20actions&logoColor=white)](https://github.com/programminghoch10/MagicalProtection/actions/workflows/build.yml)
[![GitHub Automatic Update Workflow Status](https://img.shields.io/github/actions/workflow/status/programminghoch10/MagicalProtection/autoupdate.yml?logo=github%20actions&logoColor=white)](https://github.com/programminghoch10/MagicalProtection/actions/workflows/autoupdate.yml)
[![GitHub last commit](https://img.shields.io/github/last-commit/programminghoch10/MagicalProtection?logo=git&logoColor=white)](https://github.com/programminghoch10/MagicalProtection/commits/main) \
[![GitHub last commit](https://img.shields.io/github/last-commit/programminghoch10/MagicalProtection?logo=git&logoColor=white)](https://github.com/programminghoch10/MagicalProtection/commits/main)
[![GitHub Latest Release Date](https://img.shields.io/github/release-date/programminghoch10/MagicalProtection?logo=github)](https://github.com/programminghoch10/MagicalProtection/releases/latest) \
[![GitHub Build Workflow Status](https://img.shields.io/github/actions/workflow/status/programminghoch10/MagicalProtection/build.yml?logo=github%20actions&logoColor=white&label=build)](https://github.com/programminghoch10/MagicalProtection/actions/workflows/build.yml)
[![ShellCheck Status](https://img.shields.io/github/actions/workflow/status/programminghoch10/MagicalProtection/shellcheck.yml?logo=github%20actions&logoColor=white&label=shellcheck)](https://github.com/programminghoch10/MagicalProtection/actions/workflows/shellcheck.yml) \
[![GitHub Repo stars](https://img.shields.io/github/stars/programminghoch10/MagicalProtection?style=social)](https://github.com/programminghoch10/MagicalProtection/stargazers) \
[![GitHub followers](https://img.shields.io/github/followers/programminghoch10?style=social)](https://github.com/programminghoch10)

Expand All @@ -16,7 +17,7 @@ Magisk-only completely systemless adblocking.
I've been loving
[`EnergizedProtection`](https://github.com/EnergizedProtection)
and its simplicity of setting it up once
and forgetting about it.
without an app and then forgetting about it.
However, setting up the
[`EnergizedProtection Magisk Module`](https://github.com/Magisk-Modules-Repo/energizedprotection)
includes executing some shell commands
Expand All @@ -34,10 +35,25 @@ updating is an easy and straight forward process.

The name `MagicalProtection` is inspired by
Magisk's Magic Mount
and _(obviously)_ by `EnergizedProtection`.
and _(obviously)_ by
[`EnergizedProtection`](https://github.com/EnergizedProtection).

## Usage / Installation

To use this Magisk module, install it and reboot.
There is nothing more to do, it will work straightaway.
_Magisk's Systemless Hosts module is not required._

## Automatic Updates

[![GitHub Automatic Update Workflow Status](https://img.shields.io/github/actions/workflow/status/programminghoch10/MagicalProtection/autoupdate.yml?logo=github%20actions&logoColor=white&label=autoupdate)](https://github.com/programminghoch10/MagicalProtection/actions/workflows/autoupdate.yml)

Updates for this module and its hosts lists are
[completely automated in GitHub Actions](https://github.com/programminghoch10/MagicalProtection/actions/workflows/autoupdate.yml).

To differentiate kinds of module updates,
the version info contains two version numbers:
The module version (`mv`)
and the hosts version (`hv`).
Both will tick up individually
as updates for module and hosts are deployed.

0 comments on commit e317f41

Please sign in to comment.