aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Corentin Thomasset <corentin.thomasset74@gmail.com> 2022-04-13 23:05:55 +0200
committerGravatar Corentin Thomasset <corentin.thomasset74@gmail.com> 2022-04-13 23:08:09 +0200
commit1134e0b822edbc25ce9ff83007bf5d331a1becbd (patch)
tree547177e6716703769c6ff6e0447f7865d2f6d92c
parentb4b4ddc304a19dd9e086c32ee0708fea030f4d29 (diff)
downloadit-tools-1134e0b822edbc25ce9ff83007bf5d331a1becbd.tar.gz
it-tools-1134e0b822edbc25ce9ff83007bf5d331a1becbd.tar.zst
it-tools-1134e0b822edbc25ce9ff83007bf5d331a1becbd.zip
docs: updated readme
-rw-r--r--README.md50
1 files changed, 23 insertions, 27 deletions
diff --git a/README.md b/README.md
index c71b278..83ff032 100644
--- a/README.md
+++ b/README.md
@@ -1,59 +1,55 @@
-# it-tools
+![logo](.github/logo.png)
-This template should help get you started developing with Vue 3 in Vite.
+Aggregated set of useful tools that every developer may need once in a while. Available [here](https://dev.it-tools.tech).
-## Recommended IDE Setup
+## Functionalities and roadmap
-[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin).
-
-## Type Support for `.vue` Imports in TS
-
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+Please check the [issues](https://github.com/CorentinTh/it-tools/issues) to see if some feature listed to be implemented.
-If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
+You have an idea of a tool? Submit a [feature request](https://github.com/CorentinTh/it-tools/issues/new?assignees=corentinth&labels=&template=feature_request.md&title=)!
-1. Disable the built-in TypeScript Extension
- 1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
- 2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
-2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
+## Contribute
-## Customize configuration
+### Recommended IDE Setup
-See [Vite Configuration Reference](https://vitejs.dev/config/).
+[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin).
-## Project Setup
+### Project Setup
```sh
npm install
```
-### Compile and Hot-Reload for Development
+#### Compile and Hot-Reload for Development
```sh
npm run dev
```
-### Type-Check, Compile and Minify for Production
+#### Type-Check, Compile and Minify for Production
```sh
npm run build
```
-### Run Unit Tests with [Vitest](https://vitest.dev/)
+#### Run Unit Tests with [Vitest](https://vitest.dev/)
```sh
-npm run test:unit
+npm run test
```
-### Run End-to-End Tests with [Cypress](https://www.cypress.io/)
+#### Lint with [ESLint](https://eslint.org/)
```sh
-npm run build
-npm run test:e2e # or `npm run test:e2e:ci` for headless testing
+npm run lint
```
-### Lint with [ESLint](https://eslint.org/)
+## Credits
-```sh
-npm run lint
-```
+Coded with ❤️ by [Corentin Thomasset](//corentin-thomasset.fr).
+
+This project is continuously deployed using [vercel.com](https://vercel.com).
+
+## License
+
+This project is under the [MIT license](LICENSE).