# Getting Started

To use it, open up your terminal in the desired directory and run the following command:

npm i simplereview

# Usage

# Register the packeget

import simplereview from 'simplereview';

or

import simplereview from './node_modules/simplereview/index.js';

# Javascript

After registering the package inside your javascript file you just need to initiate the package this:

simplereview();

# Don't forget

Your javascript file must be type="module".

# Template

# Simple use

Create a Div or Section tag with a class of simpleReview

<div class="simpleReview"></div>

You don't need to add anything else to display the stars but it is recommended that you also add a unique id, especially if you are going to have more than one review per page.

Also adding an id will give to the change interact with the review.

<div class="simpleReview" id="review1"></div>

Note: For more options see Params section at the bottom.