From c999afbce19b75a25e4f3e651e98dd114217cff6 Mon Sep 17 00:00:00 2001
From: Jonathan Clem <jclem@github.com>
Date: Tue, 21 May 2019 11:05:50 -0400
Subject: [PATCH] Add links to code in package READMEs

Intsead of having to update the READMEs for each package whenever
TypeScript signatures change, link directly to the TypeScript code.
Later, we can run a Typedoc server, perhaps.
---
 packages/core/README.md    | 55 +-------------------------------------
 packages/exit/README.md    |  6 +----
 packages/toolkit/README.md |  6 +----
 3 files changed, 3 insertions(+), 64 deletions(-)

diff --git a/packages/core/README.md b/packages/core/README.md
index 3aca1690..121d64c3 100644
--- a/packages/core/README.md
+++ b/packages/core/README.md
@@ -4,57 +4,4 @@
 
 ## Usage
 
-```
-// Logging functions
-export function debug(message: string): void
-export function warning(message: string): void
-export function error(message: string): void
-
-/**
- * sets env variable for this action and future actions in the job
- *
- * @param name      the name of the variable to set
- * @param val       the value of the variable
- * @param options   optional. See ExportOptions.
- */
-export function exportVariable(name: string, val: string): void
-
-/**
- * exports the variable and registers a secret which will get masked from logs
- * @param name the name of the variable to set
- * @param val value of the secret
- */
-export function exportSecret(name: string, val: string) {
-    exportVariable(name, val);
-    intm._issueCommand('set-secret', {}, val);
-} 
-
-/**
- * Interface for getInput options
- */
-export interface InputOptions {
-    /** Optional. Whether the input is required. If required and not present, will throw. Defaults to false */
-    required?: bool;
-}
-
-/**
- * Gets the value of an input.  The value is also trimmed.
- * 
- * @param     name     name of the input to get
- * @param     options  optional. See InputOptions.
- * @returns   string
- */
-export function getInput(name: string, options?: InputOptions): string | undefined
-
-/**
- * sets the status of the action to neutral
- * @param message 
- */
-export function setNeutral(message: string): void
-
-/**
- * sets the status of the action to failed
- * @param message 
- */
-export function setFailed(message: string): void
-```
+See [src/core.tsx](src/core.tsx).
diff --git a/packages/exit/README.md b/packages/exit/README.md
index c54d04da..cbbe0eef 100644
--- a/packages/exit/README.md
+++ b/packages/exit/README.md
@@ -4,8 +4,4 @@
 
 ## Usage
 
-```
-const exit = require('@actions/exit');
-
-// TODO: DEMONSTRATE API
-```
+See [src/exit.ts](src/exit.ts).
\ No newline at end of file
diff --git a/packages/toolkit/README.md b/packages/toolkit/README.md
index 1e2abbd7..fa5277da 100644
--- a/packages/toolkit/README.md
+++ b/packages/toolkit/README.md
@@ -4,8 +4,4 @@
 
 ## Usage
 
-```
-const github = require('@actions/toolkit');
-
-// TODO: DEMONSTRATE API
-```
+See [src/toolkit.ts](src/toolkit.ts).
\ No newline at end of file