This commit is contained in:
Joseph Garrone 2020-05-15 23:06:13 +02:00
parent 1157143981
commit 5ae60afe88
2 changed files with 25 additions and 6 deletions

View file

@ -89,6 +89,9 @@ Must keep:
- ``simplifyify`` ( for CDN build ) - ``simplifyify`` ( for CDN build )
- ``terser`` ( 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: # WARNINGS:

View file

@ -1,4 +1,3 @@
<p align="center"> <p align="center">
<img src="https://user-images.githubusercontent.com/6702424/80216211-00ef5280-863e-11ea-81de-59f3a3d4b8e4.png"> <img src="https://user-images.githubusercontent.com/6702424/80216211-00ef5280-863e-11ea-81de-59f3a3d4b8e4.png">
</p> </p>
@ -6,7 +5,7 @@
<i>#{DESC}#</i> <i>#{DESC}#</i>
<br> <br>
<br> <br>
<img src="https://github.com/#{USER_OR_ORG}#/#{REPO_NAME}#/workflows/ci/badge.svg?branch=master"> <img src="https://github.com/#{USER_OR_ORG}#/#{REPO_NAME}#/workflows/ci/badge.svg?branch=dev">
<img src="https://img.shields.io/bundlephobia/minzip/#{REPO_NAME}#"> <img src="https://img.shields.io/bundlephobia/minzip/#{REPO_NAME}#">
<img src="https://img.shields.io/npm/dw/#{REPO_NAME}#"> <img src="https://img.shields.io/npm/dw/#{REPO_NAME}#">
</p> </p>
@ -27,15 +26,32 @@
``` ```
```typescript ```typescript
import { myFunction, myObject } from '#{REPO_NAME}#'; import { myFunction, myObject } from '#{REPO_NAME}#';
//OR to import a specific file: ```
Specific import
```typescript
import { myFunction } from '#{REPO_NAME}#/myFunction' import { myFunction } from '#{REPO_NAME}#/myFunction'
import { myObject } from '#{REPO_NAME}#/myObject' 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
<script src="//unpkg.com/#{REPO_NAME}#/umd_bundle.min.js"></script>
<script>
var { myFunction, myObject } = window['#{REPO_NAME}#'];
</script>
```
Or import as an ES module:
```html
<script type="module" src="//unpkg.com/#{REPO_NAME}#/zz_esm/index.js"></script>
<script>
import { myFunction, myObject } from '#{REPO_NAME}#';
</script>
```