diff --git a/README.md b/README.md index a3b960f..584b709 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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. \ No newline at end of file +- 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 \ No newline at end of file diff --git a/public/sc.png b/public/sc.png new file mode 100644 index 0000000..04b0a02 Binary files /dev/null and b/public/sc.png differ