From 918ee550fdf3ca074f277f02a099cf6c867d80f2 Mon Sep 17 00:00:00 2001 From: Erika Heidi Date: Thu, 18 Jan 2024 16:12:45 +0100 Subject: [PATCH] readme update --- README.md | 21 +++++++++++++++++++-- phpunit.xml | 29 +++++++++++++---------------- 2 files changed, 32 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index dcca4cf..21b1094 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ -# autodocs -Automated Documentation +Autodocs is a PHP library designed to facilitate building highly customizable automated docs based on markdown templates and JSON data sources. It provides a layer of abstraction on top of which you can create your own documentation factory. + +Autodocs was built to be combined with a [Minicli](https://docs.minicli.dev) application, making it suitable for running as a scheduled task on GitHub Actions. + +## Requirements + +- PHP >= 8.2 +- Composer +- ext-json + +Visit the [Autodocs Wiki](https://github.com/erikaheidi/autodocs/wiki) for architecture details and basic documentation. + +## Tutorial + +For a detailed guide on how to implement an Autodocs application, check the tutorial on DEV: [Creating an Automated Documentation Pipeline in PHP with Autodocs and GitHub Actions](https://dev.to/erikaheidi/creating-an-automated-documentation-pipeline-in-php-with-autodocs-and-github-actions-1464). It covers everything from bootstrapping a new Minicli app and configuring it with Autodocs, creating a custom documentation page, setting up a JSON data source, and setting up a custom layout for a README page. The tutorial also covers how to create a GitHub Actions workflow to run this application and create a pull request when there are changes in the generated docs. + +## Demo + +A demo implementation that generates JSON-based README files is available in this repo: https://github.com/erikaheidi/autodocs-demo \ No newline at end of file diff --git a/phpunit.xml b/phpunit.xml index 8f4b58c..63d74f7 100644 --- a/phpunit.xml +++ b/phpunit.xml @@ -1,18 +1,15 @@ - - - - ./tests - - - - - ./app - ./src - - + + + + ./tests + + + + + + ./app + ./src + +