diff --git a/README.md b/README.md index 9381b43..628e782 100644 --- a/README.md +++ b/README.md @@ -89,6 +89,9 @@ Must keep: - ``simplifyify`` ( for CDN build ) - ``terser`` ( for CDN build ) +## Customizing the Badges + +You can [shields.io](https://shields.io) to create badges on metrics you would like to showcase. # WARNINGS: diff --git a/README.template.md b/README.template.md index d3574db..dcb0c03 100644 --- a/README.template.md +++ b/README.template.md @@ -1,4 +1,3 @@ -

@@ -6,7 +5,7 @@ #{DESC}#

- +

@@ -27,15 +26,32 @@ ``` ```typescript import { myFunction, myObject } from '#{REPO_NAME}#'; -//OR to import a specific file: +``` + +Specific import + +```typescript import { myFunction } from '#{REPO_NAME}#/myFunction' import { myObject } from '#{REPO_NAME}#/myObject' ``` -## CI +## From HTML with CDN -This repository has has continus integration and automatic publishing implemented via GitHub Action. +Expose a global ( wider browser support): -Refer to [TEMPLATE_README.md](https://github.com/#{USER_OR_ORG}#/#{REPO_NAME}#/blob/dev/TEMPLATE_README.md) for instructions. +```html + + +``` +Or import as an ES module: + +```html + + +```