diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/README.md b/README.md index ccfa2e4..efa81c6 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This is a simple command-line interface (CLI) blackjack game built using Node.js - Play blackjack against a computerized dealer. - Interactive interface with textual representations of cards. -- Basic functionalities: hit, stand, split and double down. +- Basic functionalities: hit, stand, split, and double down. - Track your cash and bet accordingly. ## Requirements @@ -18,8 +18,15 @@ This is a simple command-line interface (CLI) blackjack game built using Node.js To start the game, run the following command: ``` -node index.js +npx blackjack21 ``` +or +``` +npm install -g blackjack21 +``` +followed by `blackjack21`. + +If you want to run the module locally, clone the repository and run `npx .` or `node bin.js`. Follow the prompts displayed in the terminal to make your moves during the game. @@ -28,7 +35,8 @@ Follow the prompts displayed in the terminal to make your moves during the game. The game follows standard blackjack rules. - You'll be dealt two cards initially. -- Choose from available actions: hit, stand, split and double down. +- Bet your stake from the available denominations that is generated based on your current balance. +- Choose from available actions: hit, stand, split, and double down. - Aim to reach a hand value as close to 21 as possible without exceeding it. - Beat the dealer's hand without going bust to win.