smartacme/README.md

37 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2019-02-06 08:47:33 +00:00
# @pushrocks/smartuniverse
acme with an easy yet powerful interface in TypeScript
2018-08-12 18:58:59 +00:00
2019-02-06 08:47:33 +00:00
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartuniverse)
* [github.com (source mirror)](https://github.com/pushrocks/smartuniverse)
* [docs (typedoc)](https://pushrocks.gitlab.io/smartuniverse/)
2016-11-01 17:31:10 +00:00
## Status for master
2019-02-06 08:47:33 +00:00
[![build status](https://gitlab.com/pushrocks/smartuniverse/badges/master/build.svg)](https://gitlab.com/pushrocks/smartuniverse/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartuniverse/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartuniverse/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartuniverse.svg)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartuniverse/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartuniverse)
[![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/)
2016-11-01 17:31:10 +00:00
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
2017-01-01 17:07:09 +00:00
## Usage
2018-08-12 18:58:59 +00:00
2017-01-01 17:07:09 +00:00
Use TypeScript for best in class instellisense.
2019-01-06 19:41:21 +00:00
```javascript
import { SmartAcme } from 'smartacme';
2019-02-06 08:47:33 +00:00
let smac = new SmartAcme()
2019-01-06 19:41:21 +00:00
2019-02-06 08:47:33 +00:00
// TODO
2019-01-06 19:41:21 +00:00
```
2019-02-06 08:47:33 +00:00
For further information read the linked docs at the top of this readme.
2017-01-01 23:18:51 +00:00
2017-04-28 16:56:55 +00:00
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
2019-02-06 08:47:33 +00:00
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
2017-01-01 23:18:51 +00:00
2019-02-06 08:47:33 +00:00
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)