Skip to content

Commit

Permalink
Readme minimalistic documentation a.k.a. none for now
Browse files Browse the repository at this point in the history
  • Loading branch information
WyriHaximus committed Oct 15, 2024
1 parent 224e024 commit 89ba9ac
Show file tree
Hide file tree
Showing 5 changed files with 2,374 additions and 1,400 deletions.
13 changes: 11 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,17 @@ backward-compatibility-check: ## Check code for backwards incompatible changes
backward-compatibility-check-raw: ## Check code for backwards incompatible changes, doesn't ignore the failure ###
$(DOCKER_RUN) vendor/bin/roave-backward-compatibility-check

shell: ## Provides Shell access in the expected environment ###
$(DOCKER_RUN) ash
shell: ## Provides Shell access in the expected environment ####
$(DOCKER_RUN) bash

install: ## Install dependencies ####
$(DOCKER_RUN) composer install

update: ## Update dependencies ####
$(DOCKER_RUN) composer update -W

outdated: ## Show outdated dependencies ####
$(DOCKER_RUN) composer outdated

task-list-ci: ## CI: Generate a JSON array of jobs to run, matches the commands run when running `make (|all)` ###
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | grep -v "###" | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "%s\n", $$1}' | jq --raw-input --slurp -c 'split("\n")| .[0:-1]'
Expand Down
40 changes: 38 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,39 @@
# kubernetes-contracts
# Contracts for Kubernetes related attributes

Contracts for Kubernetes related attributes
![Continuous Integration](https://github.com/mammatusphp/kubernetes-contracts/workflows/Continuous%20Integration/badge.svg)
[![Latest Stable Version](https://poser.pugx.org/mammatus/kubernetes-contracts/v/stable.png)](https://packagist.org/packages/mammatus/kubernetes-contracts)
[![Total Downloads](https://poser.pugx.org/mammatus/kubernetes-contracts/downloads.png)](https://packagist.org/packages/mammatus/kubernetes-contracts/stats)
[![Type Coverage](https://shepherd.dev/github/mammatusphp/kubernetes-contracts/coverage.svg)](https://shepherd.dev/github/mammatusphp/kubernetes-contracts)
[![License](https://poser.pugx.org/mammatus/kubernetes-contracts/license.png)](https://packagist.org/packages/mammatus/kubernetes-contracts)

# Install

To install via [Composer](http://getcomposer.org/), use the command below, it will automatically detect the latest version and bind it with `^`.

```
composer require mammatus/kubernetes-contracts
```

# License

The MIT License (MIT)

Copyright (c) 2024 Cees-Jan Kiewiet

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"php": "^8.2"
},
"require-dev": {
"wyrihaximus/test-utilities": "^5.6"
"wyrihaximus/test-utilities": "^6.0.10"
},
"autoload": {
"psr-4": {
Expand Down
Loading

0 comments on commit 89ba9ac

Please sign in to comment.