ts-ci/README.template.md

35 lines
950 B
Markdown
Raw Normal View History

2020-05-15 22:51:31 +02:00
<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>
2021-02-27 01:12:46 +01:00
<img src="https://github.com/garronej/#{REPO_NAME}#/workflows/ci/badge.svg?branch=main">
2020-05-15 22:51:31 +02:00
<img src="https://img.shields.io/bundlephobia/minzip/#{REPO_NAME}#">
<img src="https://img.shields.io/npm/dw/#{REPO_NAME}#">
2020-05-27 22:02:44 +02:00
<img src="https://img.shields.io/npm/l/#{REPO_NAME}#">
2020-05-15 22:51:31 +02:00
</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>
</p>
# Install / Import
```bash
2020-05-27 22:02:44 +02:00
$ npm install --save #{REPO_NAME}#
2020-05-15 22:51:31 +02:00
```
2020-05-27 22:02:44 +02:00
2020-05-15 22:51:31 +02:00
```typescript
2021-08-01 03:44:42 +02:00
import { myFunction, myObject } from "update_ts_ci";
2020-05-15 23:06:13 +02:00
```
Specific imports:
2020-05-15 23:06:13 +02:00
```typescript
2020-05-27 22:02:44 +02:00
import { myFunction } from "#{REPO_NAME}#/myFunction";
import { myObject } from "#{REPO_NAME}#/myObject";
2021-08-01 04:41:14 +02:00
```