<commit_before>Serverless Plugin Boilerplate
=============================

This project was adapted from the following [CFVIZ](https://github.com/benbc/cloud-formation-viz/blob/master/cfviz)

**Note:** Serverless *v1.x.x* or higher is required.

### Get Started
* cd into your new plugin and run:
```
npm link
```

* cd into your Serverless Project's root folder and run:
```
npm link serverless-graph
```
* Install graphviz
  * Homebrew - brew install graphviz

### Run
If you have any commandline params that don't have defaults you will have to pass in any opt variables as this plugin hooks into the package step and then reads the output
* `sls graph {--opts}`
* `cat graph.out | dot -Tsvg -oexample.svg`

### TODO: Getting started - make npm package
* `npm install --save serverless-graph`
* Add serverless-graph to your plugins section of the project
* Install graphviz
  * Homebrew - brew install graphviz
* `sls graph {--opts} | dot -Tsvg -oexample.svg`<commit_msg>Changing some wording in readme<commit_after>Serverless Plugin Boilerplate
=============================

This project was adapted from the following [CFVIZ](https://github.com/benbc/cloud-formation-viz/blob/master/cfviz). Currently only supports the AWS provider.

**Note:** Serverless *v1.x.x* or higher is required.

### Get Started
* cd into your new plugin and run:
```
npm link
```

* cd into your Serverless Project's root folder and run:
```
npm link serverless-graph
```
* Install graphviz
  * Homebrew - brew install graphviz
* Add serverless-graph to the plugins section of your serverless.yml

### Run
If you have any commandline params that don't have defaults you will have to pass in any opt variables as this plugin hooks into the package step and then reads the output
* `sls graph {--opts}`
* `cat graph.out | dot -Tsvg -oexample.svg`

### TODO: Getting started - make npm package
* `npm install --save serverless-graph`
* Add serverless-graph to the plugins section of your serverless.yml
* Install graphviz
  * Homebrew - brew install graphviz
* `sls graph {--opts} | dot -Tsvg -oexample.svg`
{'fraction_non_alphanumeric': 0.12458073790129372, 'fraction_numerical': 0.0009583133684714902, 'mean_word_length': 4.299492385786802, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '586110', 'n_tokens_mistral': 629, 'n_tokens_neox': 601, 'n_words': 256}