From 12788c784aab2c13fae3b3f743b15d0d585b628f Mon Sep 17 00:00:00 2001 From: Josh Lubaway Date: Wed, 20 Jul 2016 22:54:29 -0700 Subject: [PATCH 1/2] Add instructions on how to read the handbook. I'm getting started with TypeScript and I was linked to this repository from a few different places. I do not believe the readme is informative enough to newcomers. After some more research it seems that this handbook is meant to be read online, or from the Markdown files directly in this repository. If this is incorrect, I will gladly update the readme, or I would appreciate it if someone more knowledgeable could provide some insight thanks :) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 539e83cfb..7aad899d6 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,6 @@ [![Build Status](https://travis-ci.org/Microsoft/TypeScript-Handbook.svg)](https://travis-ci.org/Microsoft/TypeScript-Handbook) -The TypeScript Handbook is a comprehensive guide to the TypeScript language +The TypeScript Handbook is a comprehensive guide to the TypeScript language. It is meant to be read online at [typescriptlang.org](https://www.typescriptlang.org/docs/handbook/basic-types.html) or [directly from this repository](pages/Basic Types.md). Please see the [latest TypeScript Language Specification](https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md) for more details. From 632d8aae6eb17759ed53f5313069132211907ad5 Mon Sep 17 00:00:00 2001 From: Josh Lubaway Date: Wed, 20 Jul 2016 22:58:05 -0700 Subject: [PATCH 2/2] Adhere to one sentence per line style guide. --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7aad899d6..b57f9cfce 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ [![Build Status](https://travis-ci.org/Microsoft/TypeScript-Handbook.svg)](https://travis-ci.org/Microsoft/TypeScript-Handbook) -The TypeScript Handbook is a comprehensive guide to the TypeScript language. It is meant to be read online at [typescriptlang.org](https://www.typescriptlang.org/docs/handbook/basic-types.html) or [directly from this repository](pages/Basic Types.md). +The TypeScript Handbook is a comprehensive guide to the TypeScript language. +It is meant to be read online at [typescriptlang.org][1] or [directly from this repository](pages/Basic Types.md). Please see the [latest TypeScript Language Specification](https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md) for more details. + +[1]: https://www.typescriptlang.org/docs/handbook/basic-types.html