Skip to content

Commit 208d8ad

Browse files
authored
Update README.md
1 parent 6dc16a9 commit 208d8ad

File tree

1 file changed

+2
-44
lines changed

1 file changed

+2
-44
lines changed

README.md

Lines changed: 2 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -19,51 +19,9 @@ If you are using your application in your day-to-day job, on presentation demos,
1919

2020
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/R6R42U8CL)
2121

22-
## 🚀 Installation
22+
## 📃 Documentation
2323

24-
You can install the package via composer:
25-
26-
```bash
27-
composer require renoki-co/laravel-php-k8s
28-
```
29-
30-
Publish the config:
31-
32-
```bash
33-
$ php artisan vendor:publish --provider="RenokiCo\LaravelK8s\LaravelK8sServiceProvider" --tag="config"
34-
```
35-
36-
## 🙌 Usage
37-
38-
The cluster configuration can be found in the `config/k8s.php` file. You can get started directly with the `/.kube/config` file you already have.
39-
40-
```php
41-
use RenokiCo\LaravelK8s\LaravelK8sFacade;
42-
43-
foreach (LaravelK8sFacade::getAllConfigMaps() as $cm) {
44-
// $cm->getName();
45-
}
46-
```
47-
48-
For further documentation, check [renoki-co/php-k8s](https://github.com/renoki-co/php-k8s).
49-
50-
## Multiple connections
51-
52-
The package supports multiple connections configurations. If you wish to select a specific one (not the default one), call `connection` before getting the cluster.
53-
54-
```php
55-
use RenokiCo\LaravelK8s\LaravelK8sFacade;
56-
57-
$cluster = LaravelK8sFacade::connection('http')->getCluster();
58-
```
59-
60-
## Getting the cluster instance
61-
62-
You can also call `getCluster()` to get the instance of `\RenokiCo\PhpK8s\KubernetesCluster`:
63-
64-
```php
65-
$cluster = LaravelK8sFacade::getCluster();
66-
```
24+
[The entire documentation is available on Gitbook 🌍](https://rennokki.gitbook.io/php-k8s/frameworks/laravel)
6725

6826
## 🐛 Testing
6927

0 commit comments

Comments
 (0)