update README

lando · May 5, 2023 · 3219fbe · 3219fbe
1 parent 60f4b0b
commit 3219fbe
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,3 @@
-## v2.0.0 - [May 1, 2023](https://github.com/lando/setup-lando/releases/tag/v2.0.0)
+## v2.0.0-beta.1 - [May 1, 2023](https://github.com/lando/setup-lando/releases/tag/v2.0.0-beta.1)
 
-* Initial release.
+* Initial release. See [README.md](https://github.com/lando/setup-lando).
diff --git a/README.md b/README.md
@@ -4,7 +4,6 @@ This action installs Lando in GitHub Actions. With it you can:
 
 * Install using a version-spec-ish eg `3`, `3.12`, `3.x`, `3.14.0`
 * Install using convenience aliases eg `stable`, `4-latest`, `main` `3-edge`
-* Install and compile directly from a source `ref`
 * Set [global Lando config](https://docs.lando.dev/core/global.html) configuration
 
 > **NOTE:** If you are using a self-hosted or custom runner you may need to install the needed Lando dependenices eg Docker and Docker Compose for Lando to work correctly!
@@ -29,6 +28,33 @@ All inputs are optional. If you do nothing the latest `stable` Lando will be ins
   uses: lando/setup-lando@v2
 ```
 
+### Advanced Usage
+
+**Version spec and config file:**
+
+```yaml
+- name: Setup Lando
+  uses: lando/setup-lando@v2
+  with:
+    lando-version: ">2"
+    config-file: config.yaml
+```
+
+**Version file and config list:**
+
+```yaml
+- name: Setup Lando
+  uses: lando/setup-lando@v2
+  with:
+    lando-version-file: .tool-versions
+    config: |
+      core.engine=docker-colima
+      core.telemetry=false
+      plugins.@lando/php=/home/runner/work/php/php
+```
+
+> **NOTE:** The above config is meant purely for illustration.
+
 ## Changelog
 
 We try to log all changes big and small in both [THE CHANGELOG](https://github.com/lando/setup-lando/blob/main/CHANGELOG.md) and the [release notes](https://github.com/lando/setup-lando/releases).

diff --git a/package.json b/package.json
@@ -1,9 +1,9 @@
 {
   "name": "@lando/setup-lando",
   "description": "GitHub Action to setup Lando on GitHub Actions.",
-  "version": "2.0.0",
+  "version": "2.0.0-beta.0",
   "author": "Mike Pirog @pirog",
-  "main": "index.js",
+  "main": "setup-lando.js",
   "license": "GPL-3.0",
   "repository": "https://github.com/lando/setup-lando",
   "bugs": "https://github.com/lando/setup-lando/issues",