Merge branch 'master' of https://github.com/staranbeer/typo

README.md

@@ -1 +1,82 @@
-## A Typing game for programmers
+# Typo
+
+A typing test and practice tool made specifically for developers.
+Learn to type faster and more accurately by practicing with real keywords from your favorite programming language.
+
+![typo2](https://user-images.githubusercontent.com/62498540/190850159-a95e19ea-be14-47e6-ab54-a3fe16e78cea.png)
+
+## Technologies Used
+
+- **React**
+- **Redux**
+- **Chakra UI**
+
+## Quick Start
+
+To use the app, you can head over to the official [website](https://typo-peach.vercel.app/)
+
+## Running Locally
+
+### Requirements
+
+> Make sure you have node installed. You can check which version of node you're using by running the following command.
+
+```bash
+node -v
+```
+
+> We recommend using the lts(Long-term Support) version of node.
+
+### Cloning the repo
+
+```bash
+git clone https://github.com/staranbeer/typo.git
+cd css-generator
+npm install
+npm run start
+```
+
+## How do I contribute?
+
+**All kinds of suggestions and contributions are welcome**
+
+To contribute, you can fork the project repository so that you can have your own copy of the project on your github.
+
+1. Go to the repository on GitHub: https://github.com/staranbeer/typo
+
+2. Click the "Fork" Button in the upper right-hand corner of the interface.
+
+3. After the repository has been forked, you will be taken to your copy of the `typo` repository
+
+4. Now you can clone the repository locally by running the following command on your terminal.
+
+```bash
+git clone https://github.com/YOUR_USER_NAME/typo.git
+```
+
+5. Check out a new branch so you don't make changes to the main branch.
+
+```bash
+git checkout -b your-branch-name
+```
+
+6. You can commit any changes you make by running:
+
+```bash
+git add .
+git commit -m "i changed something"
+```
+
+7. After you're done commiting your changes, you can push changes to your branch by running.
+
+```bash
+git push origin <your-branch-name>
+```
+
+8. Now, go to your repository on github and click on the compare and pull request button.
+
+After your changes are approved, They will be merged with the primary codebase.
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)