README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: github-action-string-transformer

# Tags of this project
tags:
  - github-action
  - typescript

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse-github-actions/string-transformer

config: {}

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/v/release/cloudposse-github-actions/string-transformer.svg"
    url: "https://github.com/cloudposse-github-actions/string-transformer/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

related: []

# Short description of this project
description: |
  A helper for transforming strings in GitHub Actions

introduction: |-
  This is a GitHub Action that can be used to transform strings in GitHub Actions. 
references:
  - name: "github-actions-workflows"
    description: "Reusable workflows for different types of projects"
    url: "https://github.com/cloudposse/github-actions-workflows"
  - name: "example-github-action-release-workflow"
    description: "Example application with complicated release workflow"
    url: "https://github.com/cloudposse/example-github-action-release-workflow"

# How to use this project
usage: |
  
    ```yaml
      - name: Action Lowercase
        id: lowercase
        uses: ./ # Uses an action in the root directory
        with:
          operation: 'lowercase'
          input-string: 'Hello World'
          
      - name: Action UpperCase
        id: uppercase
        uses: ./ # Uses an action in the root directory
        with:
          operation: 'uppercase'
          input-string: 'Hello World'
          
      - name: Action Kebabcase
        id: kebabcase
        uses: ./ # Uses an action in the root directory
        with:
          operation: 'kebabcase'
          input-string: 'Hello World'
    ```
  
  Then Fetch the result with:
      
     ```yaml
        - name: Get the output
          run: echo "The output was ${{ steps.lowercase.outputs.output-string }}"
     ```  

include:

# Contributors to this project
contributors:
  - name: "Benjamin Smith"
    github: "Benbentwo"