Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean README.md #19

Merged
merged 1 commit into from
Oct 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 0 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,6 @@

[中文说明](README.zh-CN.md)

[![Setup-Bend@Dev](https://github.com/hustcer/setup-bend/actions/workflows/basic.yml/badge.svg)](https://github.com/hustcer/setup-bend/actions/workflows/basic.yml)

This GitHub Action will setup a [Bend](https://github.com/HigherOrderCO/Bend) environment for you. It should work on Github `macos`, `ubuntu`, and `Windows` runners.

## Usage

### Basic

It's quite simple to use `hustcer/setup-bend`, just follow the example below:

```yaml
steps:
- name: Checkout
uses: actions/[email protected]

- name: Setup Bend
uses: hustcer/setup-bend@v1

- name: Check Bend Version
run: |
bend --version

```

Or, check the [test.yaml](https://github.com/hustcer/setup-bend/blob/main/.github/workflows/test.yml) example.

In rare circumstances you might get rate limiting errors, if this happens you can set the `GITHUB_TOKEN` environment variable.

```yaml
- uses: hustcer/setup-bend@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

### Inputs

Currently no input required

## License

Licensed under:
Expand Down
38 changes: 0 additions & 38 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,5 @@
# Milestone Action

[![Setup-Bend@Dev](https://github.com/hustcer/setup-bend/actions/workflows/basic.yml/badge.svg)](https://github.com/hustcer/setup-bend/actions/workflows/basic.yml)

本 GitHub Action 将为你配置一个 [Bend](https://github.com/HigherOrderCO/Bend) 开发环境。适用于 Github `macos`, `ubuntu` 和 `Windows` 工作流运行时镜像。


## 使用

### 基础使用

使用 `hustcer/setup-bend` 非常简单,只需要按照下面示例即可:

```yaml
steps:
- name: Checkout
uses: actions/[email protected]

- name: Setup Bend
uses: hustcer/setup-bend@v1

- name: Check Bend Version
run: |
bend --version
```

或者也可以参考下本仓库的 [test.yaml](https://github.com/hustcer/setup-bend/blob/main/.github/workflows/test.yml) 例子。

在极少数情况下,你可能会看到速率限制之类的错误。如果发生这种情况,你可以通过设置 `GITHUB_TOKEN` 环境变量来避免该问题:

```yaml
- uses: hustcer/setup-bend@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

### 输入

目前本 Action 不需要任何输入

## 许可

Licensed under:
Expand Down