From df4a846a254c062f16156654c0ace3c21904a9be Mon Sep 17 00:00:00 2001 From: MurilloCunha <62815895+MurilloCunha@users.noreply.github.com> Date: Mon, 28 Jun 2021 13:54:59 -0300 Subject: [PATCH] Update README.md --- README.md | 79 +++++++++++++------------------------------------------ 1 file changed, 19 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index 02aac3f..ac5b9bd 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,29 @@ -# Getting Started with Create React App +# Scrabble Scoreboard -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +Keep your scrabble matches score and consult the dictionary to contest other players moves! -## Available Scripts +- React -In the project directory, you can run: +- only pt-BR for now -### `yarn start` +## Contributing -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +### 01. Install dependencies -The page will reload if you make edits.\ -You will also see any lint errors in the console. +```sh +$ yarn +``` -### `yarn test` +### 02. Run project -Launches the test runner in the interactive watch mode.\ -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. +```sh +$ yarn start +``` -### `yarn build` +### 03. Contributing + + Feel free to fork and contribute to the project + +## License -Builds the app for production to the `build` folder.\ -It correctly bundles React in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.\ -Your app is ready to be deployed! - -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. - -### `yarn eject` - -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** - -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. - -Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. - -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. - -## Learn More - -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). - -To learn React, check out the [React documentation](https://reactjs.org/). - -### Code Splitting - -This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) - -### Analyzing the Bundle Size - -This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) - -### Making a Progressive Web App - -This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) - -### Advanced Configuration - -This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) - -### Deployment - -This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) - -### `yarn build` fails to minify - -This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) +[MIT](license) © Murillo Cunha