nickytonline/connect-four

Update documentation with a reference to the Wikipedia article for Connect Four

nickytonline opened this issue · 5 comments

Describe the bug A clear and concise description of what the bug is.

The README currently does not explain what Connect Four is.

Expected behavior A clear and concise description of what you expected to
happen.

Add an excerpt and a reference to the article on Wikipedia in the README.md.

[![Netlify Status](https://api.netlify.com/api/v1/badges/9d86a366-98d4-48d3-acf1-0fd2c817daec/deploy-status)](https://app.netlify.com/sites/awesome-connect-four/deploys)

# connect-four

- A web based version of the classic game Connect Four
+ A web based version of the classic game Connect Four.

+ > *Connect Four* (also known as *Connect 4*, *Four Up*, *Plot Four*, *Find Four*, *Captain’s Mistress*, *Four in a Row*, *Drop Four*, and *Gravitrips* in the Soviet Union) is a two-player  [connection](https://en.wikipedia.org/wiki/Connection_game)   [board game](https://en.wikipedia.org/wiki/Board_game) , in which the players choose a color and then take turns dropping colored tokens into a seven-column, six-row vertically suspended grid. The pieces fall straight down, occupying the lowest available space within the column. The objective of the game is to be the first to form a horizontal, vertical, or diagonal line of four of one’s own tokens.
+ 
+ Reference [Connect Four on Wikipedia](https://en.wikipedia.org/wiki/Connect_Four)

## Recommended IDE Setup

[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).

## Local Development

1. Ensure that you have the
   [latest version of Node 16](https://nodejs.org/en/download/) installed.
1. If you do not have the Netlify CLI installed, follow the
   [Getting Started with Netlify CLI](https://docs.netlify.com/cli/get-started/)
   guide.
1. Run `npm install`
1. Run `ntl dev`.

## Contributing

If you're interested in contributing to the project, please read the
[contributing guidelines](CONTRIBUTING.md).

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.

Can I be assigned this issue

Done! All yours @CodeKage25.

Thank you, Nick. Will get to it! Been a bit under the weather. I want to ask that my job is to only update the documentation right? And the reference article should be from wikipedia?

No rush and yes, it's just a documentation update. I suggested Wikipedia, but if you have another great resource for the game, e.g. maybe the game brand's website, that's all good too.

Thank you Nick! Will get to it, I've been preparing for an interview.