diff --git a/README.md b/README.md index 4bd9f29..487d86d 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,9 @@ which will build and watch the entire project for changes (to both the library s Typescript builds on the left, tests run on the right: -typescript and AVA watch task +

+ typescript and AVA watch task +

Since only changed files are rebuilt and retested, this workflow remains fast even for large projects. @@ -62,7 +64,9 @@ $ yarn cov This will create an HTML report of test coverage – source-mapped back to Typescript – and open it in your default browser. -
source-mapped typescript test coverage
+

+ source-mapped typescript test coverage example +

## Generate your API docs @@ -75,7 +79,9 @@ This command generates API documentation for your library in HTML format. Since types are tracked by Typescript, there's no need to indicate types in JSDoc format. For more information, see the [typedoc documentation](http://typedoc.org/guides/doccomments/). -
source-mapped typescript test coverage
+

+ typedoc documentation example +

For more advanced documentation generation, you can provide your own [typedoc theme](http://typedoc.org/guides/themes/), or [build your own documentation](https://blog.cloudflare.com/generating-documentation-for-typescript-projects/) using the JSON typedoc export: