Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
krzema12 committed Sep 18, 2024
1 parent f1cec87 commit a97397f
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
# GitHub Actions Typing Catalog

This repository contains type definitions for various GitHub Actions APIs (inputs and outputs). It's best for action owners to provide the typings themselves and host them from within their repositories, but if it's impossible, this repo is a fallback solution.
This repository contains type definitions for various GitHub Actions APIs (inputs and outputs). It's best for action
owners to provide the typings themselves and host them from within their repositories (see
[typesafegithub/github-actions-typing](https://github.com/typesafegithub/github-actions-typing)), but if it's
impossible, this repo is a fallback solution.

It uses the same format as in [typesafegithub/github-actions-typing](https://github.com/typesafegithub/github-actions-typing) to describe the typings.
It uses the same format as in [typesafegithub/github-actions-typing](https://github.com/typesafegithub/github-actions-typing)
to describe the typings.

This repo is to GitHub Actions what [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) is to TypeScript libraries, or [SchemaStore](https://github.com/SchemaStore/schemastore) is to JSON.
This repo is to GitHub Actions what [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) is to
TypeScript libraries, [typeshed](https://github.com/python/typeshed) is to Python ecosystem, or
[SchemaStore](https://github.com/SchemaStore/schemastore) is to JSON.

0 comments on commit a97397f

Please sign in to comment.