From a97397f39723591b5010fa1c89ba22da8e091c01 Mon Sep 17 00:00:00 2001 From: Piotr Krzeminski Date: Wed, 18 Sep 2024 08:45:53 +0200 Subject: [PATCH] Improve README --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c2acdc0..b912a53 100644 --- a/README.md +++ b/README.md @@ -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.