<commit_before>EnjoyHint
=========
**EnjoyHint** is a web-tool that provides the simplest way to create interactive tutorials and hints for your site or web-application. It can also be used to highlight and sign application elements.  

EnjoyHint is free software distributed under the terms of MIT license.
  
#### Demo
* [TODO app demo](http://xbsoftware.github.io/enjoyhint/) ([downloadable package](http://xbsoftware.github.io/enjoyhint/enjoyhint_todo_demo.zip))
* [A small guide on EnjoyHint](http://xbsoftware.github.io/enjoyhint/example1.html)

#### Dependencies
EnjoyHint require the following plugins and libs:

* jQuery v3.5.1
* jQuery.scrollTo v2.1.2
* KineticJS > v5.1.0

#### Installation
You can install it through `bower` package manager:
```
bower install enjoyhint
```
Alternative way:
- Download the latest version of EnjoyHint
- Extract the archive with EnjoyHint.
- Move the EnjoyHint directory to somewhere on your webserver
- Insert next lines into your page's \<head\> tag:
```html
  <!-- External libraries -->
  <script src="https://code.jquery.com/jquery-3.5.1.min.js"></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/kineticjs/5.2.0/kinetic.js"></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-scrollTo/2.1.2/jquery.scrollTo.min.js"></script>
  <!-- Enjoyhint library -->
  <link href="<pathontheserver>/enjoyhint/enjoyhint.css" rel="stylesheet">
  <script src="<pathontheserver>/enjoyhint/enjoyhint.min.js"></script>
```

#### Initialization and configuration:
```javascript
//initialize instance
var enjoyhint_instance = new EnjoyHint({});

//simple config. <commit_msg>Changed npm installation path in readme<commit_after>EnjoyHint
=========
**EnjoyHint** is a web-tool that provides the simplest way to create interactive tutorials and hints for your site or web-application. It can also be used to highlight and sign application elements.  

EnjoyHint is free software distributed under the terms of MIT license.
  
#### Demo
* [TODO app demo](http://xbsoftware.github.io/enjoyhint/) ([downloadable package](http://xbsoftware.github.io/enjoyhint/enjoyhint_todo_demo.zip))
* [A small guide on EnjoyHint](http://xbsoftware.github.io/enjoyhint/example1.html)

#### Dependencies
EnjoyHint require the following plugins and libs:

* jQuery v3.5.1
* jQuery.scrollTo v2.1.2
* KineticJS > v5.1.0

#### Installation
You can install it through `node` or `bower`package managers:
```
npm install xbs-enjoyhint
```
```
bower install xbs-enjoyhint
```
Alternative way:
- Download the latest version of EnjoyHint from GitHub.
- Extract the archive with EnjoyHint.
- Move the EnjoyHint directory to somewhere on your webserver.
- Install dependencies `npm install` or `bower install` if you want to use internal libraries.
- Insert next lines into your page's \<head\> tag:
```html
  <!-- From external libraries -->
  <script src="https://code.jquery.com/jquery-3.5.1.min.js"></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/kineticjs/5.2.0/kinetic.js"></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-scrollTo/2.1.2/jquery.scrollTo.min.js"></script>

  <!-- Or from internal libraries from node_modules-->
  <script src="<pathontheserver>/jquery/dist/jquery.min.js"></script>
  <script src="<pathontheserver>/kinetic/kinetic.min.js"></script>
  <script src="<pathontheserver>/jquery.scrollto/jquery.scrollTo.min.js"></script>

  <!-- Enjoyhint library -->
  <link href="<pathontheserver>/enjoyhint/enjoyhint.css" rel="stylesheet">
  <script src="<pathontheserver>/enjoyhint/enjoyhint.min.js"></script>
```

#### Initialization and configuration:
```javascript
//initialize instance
var enjoyhint_instance = new EnjoyHint({});

//simple config. 
{'fraction_non_alphanumeric': 0.1445009365801445, 'fraction_numerical': 0.010168584426010168, 'mean_word_length': 4.7243491577335375, 'pattern_counts': {'":': 0, '<': 41, '<?xml version=': 0, '>': 43, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '696791', 'n_tokens_mistral': 1195, 'n_tokens_neox': 1125, 'n_words': 314}