Skip to content

Commit 0b8eb1d

Browse files
Updated documentation
Signed-off-by: Bastian Schwarz <bastian@codename-php.de>
1 parent fc8303f commit 0b8eb1d

2 files changed

Lines changed: 13 additions & 24 deletions

File tree

README.md

Lines changed: 12 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,19 @@
1-
# template.php.library
1+
# Deployer Base
22

3-
![Lines of code](https://img.shields.io/tokei/lines/github/codenamephp/template.php.library)
4-
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/codenamephp/template.php.library)
5-
![GitHub](https://img.shields.io/github/license/codenamephp/template.php.library)
3+
![Lines of code](https://img.shields.io/tokei/lines/github/codenamephp/deployer.base)
4+
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/codenamephp/deployer.base)
5+
![GitHub](https://img.shields.io/github/license/codenamephp/deployer.base)
66

7-
Template repository to quickstart library development.
7+
Base package that provides the very basic task interface, function abstraction and some initial tasks useful for all projects like transferring files
88

9-
## Prerequisites
10-
- PHP 8.0 or later (https://php.net)
11-
- Git (https://git-scm.com) available as global `git` command
12-
- Composer (https://getcomposer.org) available as global `composer` command
13-
- Phive (https://phar.io) available as global `phive` command
9+
## What is it?
1410

15-
If one of the CLI tools is not available as global command you may have to change the `.installer/install.php` or `composer.json`
16-
to adapt to your environment.
11+
This package is an extension to deployer that adds basic tasks and interfaces and abstracts the actual deployer API.
1712

18-
## Usage
13+
## But ... why?
1914

20-
This template uses an installer to setup all the files that need replacing of placeholders but most files
21-
are just kept as they are.
15+
I really like testable code and since the actual deploy.php is otherwise just a collection of callbacks that is hard to test I added basic interfaces and
16+
classes that encapsulate the tasks and make them reusable.
2217

23-
TODOs:
24-
1. Create the new repository on GitHub using this repository as template
25-
1. Add protection rules for master and release branches since they are not copied from the template :(
26-
1. Clone the new repository to local
27-
1. Run the installer by executing `composer run-installer`
28-
1. Add and commit your files and push them to remote
29-
1. Submit the new package to packagist
30-
1. Get to work! ;)
18+
Sure, you could make it work with lambdas but since PHP is not intended to be a functional programming language it's far easier to just throw some classes into
19+
the mix.

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "codenamephp/deployer.base",
3-
"description": "",
3+
"description": "Base package that provides the very basic task interface, function abstraction and some initial tasks useful for all projects like transferring files",
44
"type": "library",
55
"license": "Apache-2.0",
66
"authors": [

0 commit comments

Comments
 (0)