<commit_before># cumulocity-hellowidget-plugin

[![version](https://img.shields.io/npm/v/cumulocity-hellowidget-plugin.svg)](https://www.npmjs.com/package/cumulocity-hellowidget-plugin)
[![downloads](https://img.shields.io/npm/dt/cumulocity-hellowidget-plugin.svg)](http://npm-stat.com/charts.html?package=cumulocity-hellowidget-plugin)
[![MIT License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://raw.githubusercontent.com/dwiyatci/cumulocity-hellowidget-plugin/master/LICENSE.txt)

A demo app for showcasing creation of a custom Cumulocity UI widget plugin.

### Why?
Currently there is [this snore-inducing JSDoc for the API to allow adding components (widgets)](http://resources.cumulocity.com/documentation/jssdk/latest/#/core/c8y.ui.service:c8yComponentsProvider), but it is inadequately practical to show "how-to" in details. So, let's slay the Jabberwocky! :hocho: :dragon_face:

## Usage
Check out [the introduction to plugin development docs](http://cumulocity.com/guides/web/introduction/).

## Author
<NAME> ([@dwiyatci](http://tiny.cc/dwiyatci))

## License
MIT.

See [LICENSE.txt](LICENSE.txt).
<commit_msg>doc(readme): improve readme to include installation and quick start section<commit_after># cumulocity-hellowidget-plugin

[![version](https://img.shields.io/npm/v/cumulocity-hellowidget-plugin.svg)](https://www.npmjs.com/package/cumulocity-hellowidget-plugin)
[![downloads](https://img.shields.io/npm/dt/cumulocity-hellowidget-plugin.svg)](http://npm-stat.com/charts.html?package=cumulocity-hellowidget-plugin)
[![MIT License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://raw.githubusercontent.com/dwiyatci/cumulocity-hellowidget-plugin/master/LICENSE.txt)

A demo app for showcasing creation of a custom Cumulocity UI widget plugin.

### Why?
Currently there is [this snore-inducing JSDoc for the API to allow adding components (widgets)](http://resources.cumulocity.com/documentation/jssdk/latest/#/core/c8y.ui.service:c8yComponentsProvider), but it is inadequately practical to show "how-to" in details. So, let's slay the Jabberwocky! :hocho: :dragon_face:

## Installation
* Make sure you have Node.js >= v6.9.1 installed and npm from its [website](https://nodejs.org), or better even, use [nvm](https://github.com/creationix/nvm).

* Clone the repo, `cd` to your project directory, and setup dependencies:

```bash
$ npm run install:clean
```

## Usage
Check out [the introduction to plugin development docs](http://cumulocity.com/guides/web/introduction/).

## Quicky up and running
Oh well, I know that you guys are a bunch of lazy people. How to get this app deployed and see it running on my tenant, you ask? Be my guest:

```bash
$ npm run deploy
```

After a few more steps in interactive command line user interfaces, you should then be able to access the app on `https://<your-tenant-url>/apps/hellowidgetapp/`.

## Author
<NAME> ([@dwiyatci](http://tiny.cc/dwiyatci))

## License
MIT.

See [LICENSE.txt](LICENSE.txt).

{'fraction_non_alphanumeric': 0.14247669773635152, 'fraction_numerical': 0.002330226364846871, 'mean_word_length': 5.313025210084033, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 7, 'https://': 13, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5035178', 'n_tokens_mistral': 1053, 'n_tokens_neox': 969, 'n_words': 237}