Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmed-mgd committed Jul 5, 2024
1 parent 121a4d5 commit 6f3c965
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Battleship

Web implementation of the board game "Battleship" using vanilla Javascript.
Compete against the computer in the classic game of "Battleship." Implemented using vanilla JavaScript.

![screenshot](public/sc.png)

## Installation and Usage

Expand All @@ -10,6 +12,11 @@ Clone the repository and navigate into the directory. Run:
npm install
```

To run the game in a development environment:
```bash
npm run dev
```

To run test fixtures:
```bash
npm test
Expand All @@ -18,4 +25,11 @@ npm test
## Lessons Learned

- Setting up and unit-testing with Jest.
- More time should be spent in the planning stage determining how different components of the project should interact.
- Enumerating different states makes it easier to keep track of game logic.
- More time should be spent in the planning stage determining how different components of the project should interact.

## Future Implementations

- Drag and drop board setup for the user
- Dashboard displaying each user's fleet and sunk ships
- Integrate AI or algorithmic logic for CPU play
Binary file added public/sc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6f3c965

Please sign in to comment.