Skip to content

Commit

Permalink
docs: update project description and key features in README.md (#484)
Browse files Browse the repository at this point in the history
Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com>
  • Loading branch information
threeal authored Oct 31, 2024
1 parent 295bd7b commit d770e47
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,16 @@

# Action Starter

A minimalistic [GitHub repository template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) to kickstart your [GitHub Action](https://github.com/features/actions) project.
A minimalist template for starting a new [GitHub Action](https://github.com/features/actions) project.

This template provides a basic GitHub Action project containing a sample [JavaScript action](https://docs.github.com/en/actions/sharing-automations/creating-actions/creating-a-javascript-action) written in [TypeScript](https://www.typescriptlang.org/), with built-in support for formatting, linting, testing, and continuous integration.

## Key Features

- Includes a sample metadata file for a GitHub action.
- Develops logic for the GitHub action in [Node.js](https://nodejs.org/en) using the following stacks:
- [Yarn](https://yarnpkg.com/) for project management.
- [TypeScript](https://www.typescriptlang.org/) for type checking.
- [Jest](https://jestjs.io/) for unit testing.
- [ESLint](https://eslint.org/) for static analysis.
- [Prettier](https://prettier.io/) for code formatting.
- Provides a sample workflow file for testing the action.
- Supports dependency updates with [Dependabot](https://docs.github.com/en/code-security/dependabot).
- Minimal GitHub Action project written in TypeScript with [ESM](https://nodejs.org/api/esm.html) support.
- Uses [Yarn](https://yarnpkg.com/) as the package manager with [Plug'n'Play](https://yarnpkg.com/features/pnp) support.
- Supports formatting with [Prettier](https://prettier.io/), linting with [ESLint](https://eslint.org/), and testing with [Jest](https://jestjs.io/).
- Preconfigured workflows for [Dependabot](https://docs.github.com/en/code-security/dependabot) and [GitHub Actions](https://github.com/features/actions).

## Usage

Expand Down

0 comments on commit d770e47

Please sign in to comment.