Update docs.

This commit is contained in:
Greyscale 2024-05-18 20:16:53 +02:00
parent 07c4403737
commit 7879d7a9b8
2 changed files with 25 additions and 20 deletions

2
.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
/.idea
/.secrets

View file

@ -4,10 +4,13 @@ Fundamentally, this is the psuedo 'brand' that I publish open source projects.
## Projects ## Projects
| Name | How do I get it | Description | Build | Tests | QC | | Name | How do I get it | Description | Build | Tests | QC |
|----------------------------------------------------------------------------------------------------|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |----------------------------------------------------------------------------------------------------|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Benzine Core](https://github.com/benzine-framework/core) | `composer require benzine/core` | Wrote too much boilerplate. Patience met its demise. Realised that all the little bits of glue I was writing was effectively a framework. Packaged it as such. | N/A | [![PHPUnit](https://github.com/benzine-framework/core/actions/workflows/test.yml/badge.svg)](https://github.com/benzine-framework/core/actions/workflows/test.yml) | [![Trunk.io Check](https://github.com/benzine-framework/core/actions/workflows/trunk.check.yml/badge.svg)](https://github.com/benzine-framework/core/actions/workflows/trunk.check.yml) | | [Benzine Core](https://github.com/benzine-framework/core) | `composer require benzine/core` | Wrote too much boilerplate. Patience met its demise. Realised that all the little bits of glue I was writing was effectively a framework. Packaged it as such. | N/A | [![PHPUnit](https://github.com/benzine-framework/core/actions/workflows/test.yml/badge.svg)](https://github.com/benzine-framework/core/actions/workflows/test.yml) | [![Trunk.io Check](https://github.com/benzine-framework/core/actions/workflows/trunk.check.yml/badge.svg)](https://github.com/benzine-framework/core/actions/workflows/trunk.check.yml) |
| [Benzine ORM](https://github.com/benzine-framework/orm) | `composer require benzine/orm` | Frustrated with Doctrine and Eloquent, I made my own ORM with blackjack and hookers. | N/A | [![PHPUnit](https://github.com/benzine-framework/orm/actions/workflows/test.yml/badge.svg)](https://github.com/benzine-framework/orm/actions/workflows/test.yml) | [![Trunk.io Check](https://github.com/benzine-framework/orm/actions/workflows/trunk.check.yml/badge.svg)](https://github.com/benzine-framework/orm/actions/workflows/trunk.check.yml) | | [Benzine ORM](https://github.com/benzine-framework/orm) | `composer require benzine/orm` | Frustrated with Doctrine and Eloquent, I made my own ORM with blackjack and hookers. | N/A | [![PHPUnit](https://github.com/benzine-framework/orm/actions/workflows/test.yml/badge.svg)](https://github.com/benzine-framework/orm/actions/workflows/test.yml) | [![Trunk.io Check](https://github.com/benzine-framework/orm/actions/workflows/trunk.check.yml/badge.svg)](https://github.com/benzine-framework/orm/actions/workflows/trunk.check.yml) |
| [Benzine DevTools](https://github.com/benzine-framework/dev-tools) | `composer require benzine/dev-tools` | A collection of tools that I use to develop Benzine projects. | N/A | N/A | [![Trunk.io Check](https://github.com/benzine-framework/dev-tools/actions/workflows/trunk.check.yml/badge.svg)](https://github.com/benzine-framework/dev-tools/actions/workflows/trunk.check.yml) | | [Benzine DevTools](https://github.com/benzine-framework/dev-tools) | `composer require benzine/dev-tools` | A collection of tools that I use to develop Benzine projects. | N/A | N/A | [![Trunk.io Check](https://github.com/benzine-framework/dev-tools/actions/workflows/trunk.check.yml/badge.svg)](https://github.com/benzine-framework/dev-tools/actions/workflows/trunk.check.yml) |
| [Github Action - Get Datetime](https://github.com/benzine-framework/action-get-datetime) | `uses: benzine-framework/action-get-datetime@v1` | Simple action that names datetimes more useful in github actions. | | ![Tests Status](https://img.shields.io/github/actions/workflow/status/benzine-framework/action-get-datetime/test.yml?logo=github&label=Tests) | ![QC Status](https://img.shields.io/github/actions/workflow/status/benzine-framework/action-get-datetime/trunk.check.yml?logo=github&label=QC) |
| [Github Action - Setup PHP Project](https://github.com/benzine-framework/action-setup-php) | `uses: benzine-framework/action-setup-php@main` | Get PHP Running in GHA, install tools, add composer cache, composer install your repo in one fell swoop | | ![Tests Status](https://img.shields.io/github/actions/workflow/status/benzine-framework/action-setup-php/test.yml?logo=github&label=Tests) | ![QC Status](https://img.shields.io/github/actions/workflow/status/benzine-framework/action-setup-php/trunk.check.yml?logo=github&label=QC) |
| [Github Action - Setup Docker](https://github.com/benzine-framework/action-setup-docker) | `uses: benzine-framework/action-setup-docker@main` | Configure Docker, buildx, qemu and login to Docker Hub or GitHub Container Registry | | ![Tests Status](https://img.shields.io/github/actions/workflow/status/benzine-framework/action-setup-docker/test.yml?logo=github&label=Tests) | ![QC Status](https://img.shields.io/github/actions/workflow/status/benzine-framework/action-setup-docker/trunk.check.yml?logo=github&label=QC) |
| [Dockerized DynamoDB](https://github.com/benzine-framework/docker-dynamodb) | | A Docker image customised for running an approximation of DynamoDB Locally, with healthchecks. | [![DynamoDB](https://github.com/benzine-framework/docker-dynamodb/actions/workflows/dynamodb.yml/badge.svg)](https://github.com/benzine-framework/docker-dynamodb/actions/workflows/dynamodb.yml) | N/A | [![Trunk.io Check](https://github.com/benzine-framework/docker-dynamodb/actions/workflows/trunk.check.yml/badge.svg)](https://github.com/benzine-framework/docker-dynamodb/actions/workflows/trunk.check.yml) | | [Dockerized DynamoDB](https://github.com/benzine-framework/docker-dynamodb) | | A Docker image customised for running an approximation of DynamoDB Locally, with healthchecks. | [![DynamoDB](https://github.com/benzine-framework/docker-dynamodb/actions/workflows/dynamodb.yml/badge.svg)](https://github.com/benzine-framework/docker-dynamodb/actions/workflows/dynamodb.yml) | N/A | [![Trunk.io Check](https://github.com/benzine-framework/docker-dynamodb/actions/workflows/trunk.check.yml/badge.svg)](https://github.com/benzine-framework/docker-dynamodb/actions/workflows/trunk.check.yml) |
| [Dockerized MariaDB](https://github.com/benzine-framework/docker-mariadb) | | A Docker image customised for running MariaDB Locally, with healthchecks. | [![MariaDB](https://github.com/benzine-framework/docker-mariadb/actions/workflows/build.yml/badge.svg)](https://github.com/benzine-framework/docker-mariadb/actions/workflows/build.yml) | N/A | [![Trunk.io Check](https://github.com/benzine-framework/docker-mariadb/actions/workflows/trunk.check.yml/badge.svg)](https://github.com/benzine-framework/docker-mariadb/actions/workflows/trunk.check.yml) | | [Dockerized MariaDB](https://github.com/benzine-framework/docker-mariadb) | | A Docker image customised for running MariaDB Locally, with healthchecks. | [![MariaDB](https://github.com/benzine-framework/docker-mariadb/actions/workflows/build.yml/badge.svg)](https://github.com/benzine-framework/docker-mariadb/actions/workflows/build.yml) | N/A | [![Trunk.io Check](https://github.com/benzine-framework/docker-mariadb/actions/workflows/trunk.check.yml/badge.svg)](https://github.com/benzine-framework/docker-mariadb/actions/workflows/trunk.check.yml) |
| [Dockerized MITM Proxy](https://github.com/benzine-framework/docker-mitmproxy) | | MITMProxy is a pain in the arse, also yeah healthchecks | [![MITMProxy](https://github.com/benzine-framework/docker-mitmproxy/actions/workflows/mitmproxy.yml/badge.svg)](https://github.com/benzine-framework/docker-mitmproxy/actions/workflows/mitmproxy.yml) | N/A | [![Trunk.io Check](https://github.com/benzine-framework/docker-mitmproxy/actions/workflows/trunk.check.yml/badge.svg)](https://github.com/benzine-framework/docker-mitmproxy/actions/workflows/trunk.check.yml) | | [Dockerized MITM Proxy](https://github.com/benzine-framework/docker-mitmproxy) | | MITMProxy is a pain in the arse, also yeah healthchecks | [![MITMProxy](https://github.com/benzine-framework/docker-mitmproxy/actions/workflows/mitmproxy.yml/badge.svg)](https://github.com/benzine-framework/docker-mitmproxy/actions/workflows/mitmproxy.yml) | N/A | [![Trunk.io Check](https://github.com/benzine-framework/docker-mitmproxy/actions/workflows/trunk.check.yml/badge.svg)](https://github.com/benzine-framework/docker-mitmproxy/actions/workflows/trunk.check.yml) |