From 43f828ebb83c36dd866b2f8e67616bd1d3d62446 Mon Sep 17 00:00:00 2001 From: Luka Giorgadze Date: Tue, 16 May 2023 18:39:05 +0400 Subject: [PATCH] update README --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c1fc886..337006b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -# ORY CLI GitHub Action +# Ory CLI GitHub Action -This repository hosts a reusable GitHub Action that enables you to run any command with the [ORY CLI](https://www.ory.sh/cli/) within your workflows. The action authenticates with the ORY CLI using the provided username and password, and then executes the specified ORY CLI command. This action is particularly useful for CI/CD pipelines that involve ORY operations. +This repository hosts a reusable GitHub Action that enables you to run any command with the [Ory CLI](https://www.ory.sh/cli/) within your workflows. The action authenticates with the Ory CLI using the provided username and password, and then executes the specified Ory CLI command. This action is particularly useful for CI/CD pipelines that involve Ory operations. -This action is designed to be flexible and easy to use. Simply provide your ORY username and password, and the ORY CLI command you wish to run. The action will handle the authentication and command execution for you, making it easier than ever to include ORY operations in your GitHub workflows. +This action is designed to be flexible and easy to use. Simply provide your Ory username and password, and the Ory CLI command you wish to run. The action will handle the authentication and command execution for you, making it easier than ever to include Ory operations in your GitHub workflows. ## Usage -To use the ORY CLI GitHub Action, you need to include it as a step in your workflow file. +To use the Ory CLI GitHub Action, you need to include it as a step in your workflow file. Here's a basic example: @@ -15,7 +15,7 @@ Here's a basic example: steps: - uses: actions/checkout@v3 - - name: Run ORY CLI Command + - name: Run Ory CLI Command uses: lomsa-dev/ory-action@v1 with: username: ${{ secrets.ORY_USERNAME }} @@ -27,7 +27,7 @@ steps: ... ``` -Replace `${{ secrets.ORY_USERNAME }}` and `${{ secrets.ORY_PASSWORD }}` with your ORY username and password, respectively. **It's highly recommended to store sensitive information like passwords as encrypted secrets in your repository or organization.** +Replace `${{ secrets.ORY_USERNAME }}` and `${{ secrets.ORY_PASSWORD }}` with your Ory username and password, respectively. **It's highly recommended to store sensitive information like passwords as encrypted secrets in your repository or organization.** ## Contribution Contributions to improve this GitHub Action are welcome. Please feel free to open an issue or submit a pull request. \ No newline at end of file