<commit_before># Coverflow ReactJS
## Installation instructions


    git clone https://github.com/leon-good-life/coverflow-react.git
    cd coverflow
    npm install
    npm start


## Live Demo
https://storage.googleapis.com/coverflow-react/index.html

## Screencast on YouTube
[![Link to screencast on YouTube](youtube-screenshot.png)](https://www.youtube.com/watch?v=PpykYaLD4vI)



<commit_msg>Added Usage paragraph to Readme<commit_after># Coverflow ReactJS
## Installation instructions


    git clone https://github.com/leon-good-life/coverflow-react.git
    cd coverflow
    npm install
    npm start


## Live Demo
https://storage.googleapis.com/coverflow-react/index.html

## Screencast on YouTube
[![Link to screencast on YouTube](youtube-screenshot.png)](https://www.youtube.com/watch?v=PpykYaLD4vI)

## Usage
1. If you want to use this coverflow in your project, copy the "coverflow-react/src/CoverFlow" directory into your project.
```bash
cp -R PATH_OF_THIS_CLONED_PROJECT/coverflow-react/src/CoverFlow PATH_OF_YOUR_PROJECT/PATH_OF_3RD_PARTY_COMPONENTS/CoverFlow
```

2. import CoverFlow
```javascript
import CoverFlow from './CoverFlow/CoverFlow';
```

3. Create an array of path/URLs to the images.
```javascript
const imagesArr = [
        'img/1.jpg',
        'img/2.jpg',
        'img/3.jpg',
        'img/4.jpg',
        'img/5.jpg'
    ];
```
4. Add CoverFlow Component to your project and pass images array.
```html
<CoverFlow imagesArr={imagesArr} />
```

### Optional props
* zIndex - by default it is 100. If there are conflicts with z-index in your project. You can pass zIndex you want.

{'fraction_non_alphanumeric': 0.1188118811881188, 'fraction_numerical': 0.009282178217821782, 'mean_word_length': 3.798219584569733, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 6, 'lorem ipsum': 0, 'www.': 2, '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': '2385135', 'n_tokens_mistral': 564, 'n_tokens_neox': 516, 'n_words': 140}