smartopen/README.md

37 lines
1.8 KiB
Markdown
Raw Normal View History

2019-04-16 06:26:16 +00:00
# @pushrocks/smartopen
2017-03-12 20:13:09 +00:00
open things
2019-04-16 06:26:16 +00:00
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartopen)
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartopen)
* [github.com (source mirror)](https://github.com/pushrocks/smartopen)
* [docs (typedoc)](https://pushrocks.gitlab.io/smartopen/)
2017-03-12 20:13:09 +00:00
## Status for master
2019-04-16 06:26:16 +00:00
[![build status](https://gitlab.com/pushrocks/smartopen/badges/master/build.svg)](https://gitlab.com/pushrocks/smartopen/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartopen/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartopen/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartopen.svg)](https://www.npmjs.com/package/@pushrocks/smartopen)
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartopen/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartopen)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
2017-03-12 20:13:09 +00:00
## Usage
2017-03-12 20:13:09 +00:00
Use TypeScript for best in class instellisense.
2019-04-16 06:27:54 +00:00
```typescript
import * as smartopen from '@pushrocks/smartopen';
2019-04-16 06:28:49 +00:00
const run = async () => {
await smartopen.openUrl('https://lossless.com');
};
run();
2019-04-16 06:27:54 +00:00
```
2019-04-16 06:26:16 +00:00
For further information read the linked docs at the top of this readme.
2017-03-12 20:13:09 +00:00
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
2019-04-16 06:26:16 +00:00
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
2017-03-12 20:13:09 +00:00
2019-04-16 06:26:16 +00:00
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)