add README

Author: amirfakhrullah

README.md

@@ -0,0 +1,35 @@
+# CRA-TEMPLATE-REACT-TS-TW
+
+## Using the template
+
+```cmd
+npx create-react-app my-app --template REACT-TS-TW
+```
+
+## Features included
+
+- TailwindCSS config setup
+- Full `tsconfig.json` rules so that you can easily pick which rules you wanted
+- husky for eslint and prettier formatter pre-commit
+- Extra packages installed: `axios`, `react-router`, `react-query`
+- No unused packages installed
+
+## Suitable Usage
+
+- Simple React project that doesn't really need testing
+- For those who want to quicky develop front-end with typescript and tailwind without wasting time in setting up configs and boilerplates
+
+## For Contributing
+
+### Installation
+
+```cmd
+npm install
+```
+
+If you get issues with prettier or eslint, simply run:
+
+```cmd
+npm run format
+npm run lint:fix
+```

template/README.md

@@ -1,70 +1,28 @@
-# Getting Started with Create React App
+# CRA-TEMPLATE-REACT-TS-TW
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+## Installations
 
-## Available Scripts
+PS: make sure to initialised git before setting up
 
-In the project directory, you can run:
+```cmd
+npm install
+```
 
-### `npm start`
+If you get issues with prettier or eslint, simply run:
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
+```cmd
+npm run format
+npm run lint:fix
+```
 
-The page will reload when you make changes.\
-You may also see any lint errors in the console.
+## Running Project Locally
 
-### `npm test`
+```cmd
+npm start
+```
 
-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.
+## Builds
 
-### `npm run build`
-
-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.
-
-### `npm run 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)
-
-### `npm run 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)
+```cmd
+npm run build
+```