Some minor updates to README.md

octogonz · octogonz · commit 0c3279bbab55 · 2019-09-29T15:20:18.000-07:00
diff --git a/README.md b/README.md
@@ -6,19 +6,21 @@
 [![Join the chat at https://gitter.im/web-build-tools](https://badges.gitter.im/web-build-tools.svg)](https://gitter.im/web-build-tools?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) &nbsp; [![Build Status](https://dev.azure.com/RushStack/Gearbox%20GitHub%20Projects/_apis/build/status/web-build-tools/web-build-tools%20CI%20Build?branchName=master)](https://dev.azure.com/RushStack/Gearbox%20GitHub%20Projects/_build/latest?definitionId=3&branchName=master)
 
 The home for various projects maintained by the Rush Stack community, whose mission is to develop reusable tooling
-for large scale NodeJS monorepos.
+for large scale TypeScript monorepos.
 
 ## Documentation Links
 
-- [What is Rush Stack?](https://rushstack.io/)
-- [Package API reference](https://rushstack.io/pages/api/)
-- [Gitter chat room](https://gitter.im/web-build-tools/web-build-tools): chat with the Rush Stack developers
-- [Rush](https://rushjs.io/): a scalable NodeJS build orchestrator
-- [API Extractor](https://api-extractor.com/): manages API reviews and generates .d.ts rollups
-- [API Documenter](https://api-extractor.com/pages/setup/generating_docs/): generates your API documentation website
+- [What is Rush Stack?](https://rushstack.io/) - learn about the mission behind these projects
+- [API reference](https://rushstack.io/pages/api/) - browse API documentation for NPM packages
+- [Gitter chat room](https://gitter.im/web-build-tools/web-build-tools) - chat with the Rush Stack developers
+- [Rush](https://rushjs.io/) - a build orchestrator for large scale TypeScript monorepos
+- [API Extractor](https://api-extractor.com/) - create .d.ts rollups and track your TypeScript API signatures
+- [API Documenter](https://api-extractor.com/pages/setup/generating_docs/) - use TSDoc comments to publish an API documentation website
 
 ## Published Packages
 
+<!-- the table below was generated using the ./repo-scripts/repo-toolbox script -->
+
 | Folder | Version | Changelog | Package |
 | ------ | ------- | --------- | ------- |
 | [/apps/api-documenter](./apps/api-documenter/) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fapi-documenter.svg)](https://badge.fury.io/js/%40microsoft%2Fapi-documenter) | [changelog](./apps/api-documenter/CHANGELOG.md) | [@microsoft/api-documenter](https://www.npmjs.com/package/@microsoft/api-documenter) |
@@ -61,6 +63,8 @@ for large scale NodeJS monorepos.
 
 ## Unpublished Local Projects
 
+<!-- the table below was generated using the ./repo-scripts/repo-toolbox script -->
+
 | Folder | Description |
 | ------ | -----------|
 | [/build-tests/api-documenter-test](./build-tests/api-documenter-test/) | Building this project is a regression test for api-documenter |
diff --git a/repo-scripts/repo-toolbox/src/ReadmeAction.ts b/repo-scripts/repo-toolbox/src/ReadmeAction.ts
@@ -28,6 +28,7 @@ export class ReadmeAction extends CommandLineAction {
     Sort.sortBy(orderedProjects, x => x.projectRelativeFolder);
 
     builder.append('## Published Packages\n\n');
+    builder.append('<!-- the table below was generated using the ./repo-scripts/repo-toolbox script -->\n\n');
     builder.append('| Folder | Version | Changelog | Package |\n');
     builder.append('| ------ | ------- | --------- | ------- |\n');
     for (const project of orderedProjects.filter(x => ReadmeAction._isPublished(x))) {
@@ -65,6 +66,7 @@ export class ReadmeAction extends CommandLineAction {
     }
 
     builder.append('\n\n## Unpublished Local Projects\n\n');
+    builder.append('<!-- the table below was generated using the ./repo-scripts/repo-toolbox script -->\n\n');
     builder.append('| Folder | Description |\n');
     builder.append('| ------ | -----------|\n');
     for (const project of orderedProjects.filter(x => !ReadmeAction._isPublished(x))) {
