Skip to content

Commit

Permalink
feature: Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
miltlima committed Jul 25, 2023
1 parent e957871 commit 3821081
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Goact Documentation

Goact is a command-line tool (CLI) that enables you to create pipeline stacks to automate workflows on GitHub Actions.

## Installation

To use Goact, follow the steps below to install it on your system:

1. Download the Goact source code or clone the GitHub repository.

2. Navigate to the Goact project directory.

3. Compile the Goact code to create the executable:

```bash
go build
```

Move the executable to a folder that is in your system's PATH:

```bash
sudo mv goact /usr/local/bin
```

## Usage

Goact is designed to make it easy to create pipeline stacks in GitHub Actions. With the create command, you can configure GitHub Actions and generate essential files for your actions.

## Command create

The create command is used to create the GitHub Actions configuration for a specific pipeline stack.

```bash
goact create --stack <STACK_NAME>
```

Replace <STACK_NAME> with the name of the stack you want to create, for example, node.js, python, java, golang or ruby.

```bash
goact create --stack node.js
```

0 comments on commit 3821081

Please sign in to comment.