From 8582b1b9076103d96b0ac6647b4d55ee4cebb617 Mon Sep 17 00:00:00 2001 From: Marat Dulin Date: Thu, 13 Aug 2020 17:57:42 +0200 Subject: [PATCH] Improve README.md --- README.md | 54 ++++++++++++++++++++--------------------------- public/index.html | 4 ++-- 2 files changed, 25 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 64e343e..0884edc 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,36 @@ -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +# TypeScript exercises -## Available Scripts +Start your journey here: https://typescript-exercises.github.io/ -In the project directory, you can run: +The goal: Let everyone play with many different TypeScript features +and get an overview of TypeScript capabilities and principles. -### `yarn start` +## Things to cover -Runs the app in the development mode.
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser. + 1. Basic typing. + 2. Refining types. + 3. Union types. + 4. Merged types. + 5. Generics. + 6. Type declarations. + 7. Module augmentation. + 8. Advanced type mapping. -The page will reload if you make edits.
-You will also see any lint errors in the console. +## Rules and principles -### `yarn test` + 1. Avoid using `any` type at all costs. -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. + 2. Difficulty quickly grows one exercise after another. -### `yarn build` + 3. Feel free to send pull-requests if you've came up + with improvements! -Builds the app for production to the `build` folder.
-It correctly bundles React in production mode and optimizes the build for the best performance. + 4. Provide feedback to the creator of these exercises. -The build is minified and the filenames include the hashes.
-Your app is ready to be deployed! + 5. Enjoy. -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. +## Contributing -### `yarn eject` + 1. Your contributions are welcome. -**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/). + 2. `yarn start` starts the development server. diff --git a/public/index.html b/public/index.html index d124fba..edbc133 100644 --- a/public/index.html +++ b/public/index.html @@ -10,13 +10,13 @@ - + TypeScript Exercises