mirror of
https://github.com/garronej/ts-ci.git
synced 2025-11-30 21:43:05 +00:00
42 lines
1.2 KiB
Markdown
42 lines
1.2 KiB
Markdown
|
|
|
||
|
|
<p align="center">
|
||
|
|
<img src="https://user-images.githubusercontent.com/6702424/80216211-00ef5280-863e-11ea-81de-59f3a3d4b8e4.png">
|
||
|
|
</p>
|
||
|
|
<p align="center">
|
||
|
|
<i>#{DESC}#</i>
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
<img src="https://github.com/#{USER_OR_ORG}#/#{REPO_NAME}#/workflows/ci/badge.svg?branch=master">
|
||
|
|
<img src="https://img.shields.io/bundlephobia/minzip/#{REPO_NAME}#">
|
||
|
|
<img src="https://img.shields.io/npm/dw/#{REPO_NAME}#">
|
||
|
|
</p>
|
||
|
|
<p align="center">
|
||
|
|
<a href="https://github.com/#{USER_OR_ORG}#/#{REPO_NAME}#">Home</a>
|
||
|
|
-
|
||
|
|
<a href="https://github.com/#{USER_OR_ORG}#/#{REPO_NAME}#">Documentation</a>
|
||
|
|
-
|
||
|
|
<a href="https://gitter.im/#{REPO_NAME}#/">Chat</a>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
# Install / Import
|
||
|
|
|
||
|
|
```bash
|
||
|
|
> npm install --save #{REPO_NAME}#
|
||
|
|
```
|
||
|
|
```typescript
|
||
|
|
import { myFunction, myObject } from '#{REPO_NAME}#';
|
||
|
|
//OR to import a specific file:
|
||
|
|
import { myFunction } from '#{REPO_NAME}#/myFunction'
|
||
|
|
import { myObject } from '#{REPO_NAME}#/myObject'
|
||
|
|
```
|
||
|
|
|
||
|
|
## CI
|
||
|
|
|
||
|
|
This repository has has continus integration and automatic publishing implemented via GitHub Action.
|
||
|
|
|
||
|
|
Refer to [TEMPLATE_README.md](https://github.com/#{USER_OR_ORG}#/#{REPO_NAME}#/blob/dev/TEMPLATE_README.md) for instructions.
|
||
|
|
|
||
|
|
|