<commit_before>[![node](https://img.shields.io/node/v/gh-badges.svg)]()
[![npm (scoped)](https://img.shields.io/npm/v/@cycle/core.svg)]()
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()
[![](https://img.shields.io/badge/version-1.4-green.svg)]()

## Application Version Manager

[![](description.gif)]()

* better client storages management.
* remove all, specific or exclude values.
* custom configuring and scalability.
* works with any project type: Angular/React, Native JavaScript, jQuery etc. 
* more than just an adding a timestamp to *.js files.

> **Notice:** Version Manager has no UI, only internal JavaScript implementation. Just include it in your project & configure!

## Table of Contents

  * [Installation](#installation)
  * [Configuration](#configuration)
    - [Common options](#common-options)
    - [Auto-Copy options](#auto-copy-options)
  * [Example](#example)
  * [Demos](#demo)
  * [Questions](#questions)
  * [Licence](#licence)

## Installation

1. `cd core`.
2. `npm install`.
3. `node generator.js` (or just execute `build.bat`).

## Demo

1. [direct-keys-specifying](https://github.com/asduser/app-version-manager/tree/master/demos/1-direct-keys-specifying)
2. [data-auto-loading](https://github.com/asduser/app-version-manager/tree/master/demos/2-data-auto-loading)
3. [modifying-existing-data](https://github.com/asduser/app-version-manager/tree/master/demos/3-modifying-existing-data) 
4. [removed-keys-collection](https://github.com/asduser/app-version-manager/tree/master/demos/4-removed-keys-collection) 
5. [session-continue](https://github.com/asduser/app-version-manager/tree/master/demos/5-session-continue) 

## Configuration

Configure `core/settings.json` if needed.

#### Common options

| Parameter      | Description                                                                                                                      |
|----------------|----------------------------------------------------------------------------------------------------------------------------------|
| versionKey     | localStorage key, which contains info about current build. |
| storages    | Only `isActive` storage is used. |
| configPath    |  If `autoCopy.use` is false, the path to config.json should be set manually. |

#### Auto-Copy options

| Parameter      | Description                                                                                                      |
|----------------|-------------------------------------------------------------------------------------------------------------------|
| use    |  If `true` - a new build will have been copied there automatically, otherwise - will be created just a new version-manager build. |
| dirPath | Path to project directory, which contains the main `index.html` file. |
| buildPath | Path to load version-manager according to previous `dirPath` parameter. |

## Questions

**What does mean `PATH_TO_VERSION_MANAGER_CONFIG_JSON 404 (Not Found)` in console?**<commit_msg>[*] Removed unnecessary keys from readme<commit_after>[![node](https://img.shields.io/node/v/gh-badges.svg)]()
[![npm (scoped)](https://img.shields.io/npm/v/@cycle/core.svg)]()
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()
[![](https://img.shields.io/badge/version-1.4-green.svg)]()

## Application Version Manager

[![](description.gif)]()

* better client storages management.
* remove all, specific or exclude values.
* custom configuring and scalability.
* works with any project type: Angular/React, Native JavaScript, jQuery etc. 
* more than just an adding a timestamp to *.js files.

> **Notice:** Version Manager has no UI, only internal JavaScript implementation. Just include it in your project & configure!

## Table of Contents

  * [Installation](#installation)
  * [Configuration](#configuration)
    - [Common options](#common-options)
    - [Auto-Copy options](#auto-copy-options)
  * [Example](#example)
  * [Demos](#demo)
  * [Questions](#questions)
  * [Licence](#licence)

## Installation

1. `cd core`.
2. `npm install`.
3. `node generator.js` (or just execute `build.bat`).

## Demo

1. [direct-keys-specifying](https://github.com/asduser/app-version-manager/tree/master/demos/1-direct-keys-specifying)
2. [data-auto-loading](https://github.com/asduser/app-version-manager/tree/master/demos/2-data-auto-loading)
3. [modifying-existing-data](https://github.com/asduser/app-version-manager/tree/master/demos/3-modifying-existing-data) 
4. [removed-keys-collection](https://github.com/asduser/app-version-manager/tree/master/demos/4-removed-keys-collection) 
5. [session-continue](https://github.com/asduser/app-version-manager/tree/master/demos/5-session-continue) 

## Configuration

Configure `core/settings.json` if needed.

#### Common

| Parameter      | Description                                                                                                                      |
|----------------|----------------------------------------------------------------------------------------------------------------------------------|
| versionKey     | localStorage key, which contains info about current build. |
| storages    | Only `isActive` storage is used. |
| configPath    |  If `autoCopy.use` is false, the path to config.json should be set manually. |

#### Auto-Copy

| Parameter      | Description                                                                                                      |
|----------------|-------------------------------------------------------------------------------------------------------------------|
| use    |  If `true` - a new build will have been copied there automatically, otherwise - will be created just a new version-manager build. |
| dirPath | Path to project directory, which contains the main `index.html` file. |
| buildPath | Path to load version-manager according to previous `dirPath` parameter. |

## Questions

**What does mean `PATH_TO_VERSION_MANAGER_CONFIG_JSON 404 (Not Found)` in console?**
{'fraction_non_alphanumeric': 0.2217614861502737, 'fraction_numerical': 0.005971139492453143, 'mean_word_length': 2.1243523316062176, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 18, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 18, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2907039', 'n_tokens_mistral': 1650, 'n_tokens_neox': 1576, 'n_words': 384}