counter8/README.md

Counter8 allows you to create and update counters directly from the command line or other Node.js scripts.

# counter8

Counter8 allows you to create and update counters directly from the command line or other Node.js scripts.

## Features

- Creation of a new counter with an initial value.
- Incrementing counter values.
- Save counter values to a text file.

## Installation

1. run `npm install counter8` to install the library.
2. Run `npm install` to install necessary dependencies.

## Usage.

### Creating a new counter

To create a new counter, use the method `Counter.new(name)`. This will create a new counter file with the given name and initial value `0`.

```
const Counter = require('counter8'); // adjust the path as needed.

async function createCounter(name) {
 try {
    const counter = await Counter.new(name);
    console.log(`Counter ${name} was successfully created.`);
 } catch (error) {
    console.error(`Failed to create counter ${name}. : ${error.message}`);
 }
}

// Example usage
createCounter('myCounter');

```

### Updating a counter

To update the value of a counter, use the `counter.add(value)` method. This will increment the value of the counter by the specified amount.

```
async function updateCounter(name, value) {
 try {
    const counter = await Counter.new(name);
    await counter.add(value);
    console.log(`Counter ${name} updated to ${value}`);
 } catch (error) {
    console.error(`Failed to update counter ${name}: ${error.message}`);
 }
}

// Example usage
updateCounter('myCounter', 5);

```

## Running the code

To execute the code, create a new script (e.g. `counter-script.js`) and import the `Counter` class. You can then call the `createCounter` or `updateCounter` function as in the example above.

Run the script using Node.js:

bash node counter-script.js

## New Features
- Demo is now included by default. (v0.0.196)
- Correct calculations are now available. (v0.0.195)

## Contributions

Contributions are welcome!

If you find a bug or have a suggestion for improvement, feel free to submit a pull request or issue.

## License

The license of this project is the MIT License. See the `LICENSE` file for details.

This README provides a clear overview of the project, including installation instructions, usage examples, and information about contributions. Adjust the paths and specific details as needed to fit the structure and requirements of your project.