<commit_before># plum-sample
a sample project that uses the [plum library](https://github.com/amirkibbar/plum)

# Running the sample

Start Consul on the localhost using http port 8500 and DNS port 8600, then:

```

    $ gradlew run
```

Access the Consul UI at http://localhost:8500/ui and expect to see the PlumSample service registered:

![PlumSample service in Consul](https://raw.githubusercontent.com/amirkibbar/plum-sample/master/src/site/resources/registered-service.png)

Go to the key value store and browse through the PlumSample tree, see the access properties:

![PlumSample access properties in Consul](https://raw.githubusercontent.com/amirkibbar/plum-sample/master/src/site/resources/kv-access.png)

And the application configuration:

![PlumSample configuration](https://raw.githubusercontent.com/amirkibbar/plum-sample/master/src/site/resources/kv-config.png)<commit_msg>updated docs<commit_after># plum-sample
a sample project that uses the [plum library](https://github.com/amirkibbar/plum)

# Running the sample

```

    $ gradlew startConsul run
```

No need to install Consul on your box - the [gradle-consul-plugin](https://github.com/amirkibbar/red-apple) does that 
for you.

Access the Consul UI at [http://localhost:8501/ui](http://localhost:8501/ui) and expect to see the PlumSample service registered:

![PlumSample service in Consul](https://raw.githubusercontent.com/amirkibbar/plum-sample/master/src/site/resources/registered-service.png)

Go to the key value store and browse through the PlumSample tree, see the access properties:

![PlumSample access properties in Consul](https://raw.githubusercontent.com/amirkibbar/plum-sample/master/src/site/resources/kv-access.png)

And the application configuration:

![PlumSample configuration](https://raw.githubusercontent.com/amirkibbar/plum-sample/master/src/site/resources/kv-config.png)
{'fraction_non_alphanumeric': 0.1122394441475147, 'fraction_numerical': 0.010689470871191877, 'mean_word_length': 5.198675496688741, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 9, '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': '5841275', 'n_tokens_mistral': 598, 'n_tokens_neox': 566, 'n_words': 149}