wordle-terminal/README.md

A Wordle-like game for the terminal.

#  wordle-terminal

  

**wordle-terminal** is a Wordle-like CLI game for your terminal built with Node.js, Chalk, and Inquirer. You get six guesses and the word resets everyday.

  

<br>

  

##  Features

  

- Word resets every day at 12 AM.

- Yellow and green colors to show if your characters are correctly placed.

  

<br>

  

##  Prerequisites

  

Ensure you have **Node.js** and **npm** installed on your machine before playing this.

  

<br>

  

##  Installation & Usage

  

To play **wordle-terminal**:

  

1. Open your terminal.

  

2. Run the following command:

```bash

npm i wordle-terminal

```

  

3. Run the game by running the following command:

```bash

npx wordle

```

4. Play the game by following the commands on the screen.

<br>

  

<br>

  

##  Development & Testing

  

If you want to modify or test this package locally:

  

1. Clone the repository.

2. Run `npm link` in the project directory to make it available globally on your system.

3. Use the command `npx wordle` to play locally.

  

<br>

  

##  License

  

This project is licensed under the **ISC License**. See the [LICENSE](https://github.com/saadpocalypse/wordle-terminal/blob/main/LICENSE) file for details.

  

<br>

  

##  Contributing

  

Contributions are welcome! If you’d like to improve this package or add new features, please fork this repository, make your changes, and submit a pull request.

<br>

  

##  Notes

  

This tool is in no way involved with or endorsed by Wordle.