Skip to content

Commit

Permalink
adding a beauty readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MuriloChianfa committed Dec 7, 2023
1 parent a45be76 commit 7a4364d
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
<h1 align="center">Ioncube Encoder Action</h1>
![Banner](banner.png)

[![GitHub Super-Linter](https://github.com/MuriloChianfa/ioncube-encoder-action/actions/workflows/linter.yml/badge.svg)](https://github.com/MuriloChianfa/ioncube-encoder-action/actions/workflows/linter.yml)
[![CI](https://github.com/MuriloChianfa/ioncube-encoder-action/actions/workflows/ci.yml/badge.svg)](https://github.com/MuriloChianfa/ioncube-encoder-action/actions/workflows/ci.yml)

Automate and streamline IonCube encoding for your PHP with Laravel, Joomla, Wordpress projects with this powerful GitHub Action. Encode your source code effortlessly, ensuring an extra layer of security for your proprietary codebase.

![Banner](banner.png)
Automate and streamline IonCube encoding for your PHP project under Laravel, Joomla, Wordpress frameworks with this powerful GitHub Action. Encode your source code effortlessly, ensuring an extra layer of security for your proprietary codebase.

## Features

Expand All @@ -23,11 +21,6 @@ Automate and streamline IonCube encoding for your PHP with Laravel, Joomla, Word
- **Configure Workflow**: Copy the example workflow into your project's .github/workflows directory, adjusting parameters as needed.
- **Run Workflow**: Push your changes to trigger the IonCube encoding workflow and enjoy the automated process.

> [!IMPORTANT]
>
> Make sure to ignore the commits for encrypted files.
> After encrypt your project, test them for make sure your correct functionality.
### Usage

```yaml
Expand Down Expand Up @@ -60,6 +53,13 @@ jobs:
- ***php-target-version***: The PHP encoded files target version.
- ***arch***: Architecture of target environment runner.
<hr>
> [!IMPORTANT]
>
> Make sure to ignore the commits for encrypted files.
> After encrypt your project, test them for make sure your correct functionality.
## Example
Explore a complete example of a workflow that utilizes this action in the <a href="https://github.com/MuriloChianfa/ioncube-encoder-action">example project</a>.
Expand All @@ -85,11 +85,6 @@ be. The checklist for package development includes:
- ✅ Have no Lint warnings throughout all code.
- ✅ Include comprehensive documentation in README.md.

## Credits

- [Murilo Chianfa](https://github.com/MuriloChianfa)
- [All Contributors](../../contributors)

## Contributions

We welcome contributions! Feel free to open issues for suggestions or bug reports, and pull requests are highly appreciated.
Expand All @@ -98,6 +93,11 @@ We welcome contributions! Feel free to open issues for suggestions or bug report

If you discover any security related issues, please email murilo.chianfa@outlook.com instead of using the issue tracker.

## Credits

- [Murilo Chianfa](https://github.com/MuriloChianfa)
- [All Contributors](../../contributors)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.
Expand Down

0 comments on commit 7a4364d

Please sign in to comment.