Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
salimzeeshan committed Jun 20, 2024
1 parent 301f236 commit fc8b155
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 0 deletions.
74 changes: 74 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# 2048 Game

A web-based implementation of the popular 2048 game, built with [Next.js](https://nextjs.org/).

## Table of Contents

- [Demo](#demo)
- [Features](#features)
- [Technologies](#technologies)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)

## Demo

Check out the live demo: [2048 Game](https://2048-pearl.vercel.app/)

![2048 Game Screenshot](https://imgur.com/a/HmsiTLC)

## Features

- Classic 2048 gameplay
- Smooth animations and responsive design
- Keyboard and swipe gestures support
- Score tracking

## Technologies

- [Next.js](https://nextjs.org/)
- [React](https://reactjs.org/)
- [Vercel](https://vercel.com/) for deployment

## Installation

To run this project locally, follow these steps:

1. **Clone the repository:**
```bash
git clone https://github.com/salimzeeshan/2048.git
cd 2048-game
```

2. **Install dependencies:**
```bash
npm install
```

3. **Run the development server:**
```bash
npm run dev
```

4. Open your browser and navigate to `http://localhost:3000`.

## Usage

- Use the arrow keys or WASD keys or arrow keys to move the tiles.
- Combine tiles with the same number to merge them into a higher number.
- Swipe gestures are supported on touch devices.

## Contributing

Contributions are welcome! If you have suggestions for improvements or new features, please open an issue or submit a pull request.

1. Fork the repository
2. Create a new branch (`git checkout -b feature-branch`)
3. Make your changes
4. Commit your changes (`git commit -m 'Add some feature'`)
5. Push to the branch (`git push origin feature-branch`)
6. Open a pull request

---

Developed by [Mohammad Zeeshan Salim](https://salimzeeshan.github.io/)
Binary file removed public/audio/merge-old.mp3
Binary file not shown.

0 comments on commit fc8b155

Please sign in to comment.