mirror of
https://github.com/CorentinTh/it-tools.git
synced 2025-04-21 23:36:15 -04:00
docs: updated README.md
This commit is contained in:
parent
e025376017
commit
a9b1beb6af
2 changed files with 38 additions and 12 deletions
BIN
.github/logo.png
vendored
Normal file
BIN
.github/logo.png
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 7.8 KiB |
50
README.md
50
README.md
|
@ -1,20 +1,46 @@
|
||||||
# it-tools
|

|
||||||
|
|
||||||
## Build Setup
|
Aggregated set of useful tools that every developer may need once in a while. Available [here](https://it-tools.tech).
|
||||||
|
|
||||||
```bash
|
## Functionalities and roadmap
|
||||||
# install dependencies
|
Please check the [issues](https://github.com/CorentinTh/it-tools/issues) to see if some feature listed to be implemented.
|
||||||
$ npm install
|
|
||||||
|
|
||||||
# serve with hot reload at localhost:3000
|
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=)!
|
||||||
$ npm run dev
|
|
||||||
|
|
||||||
# build for production and launch server
|
## Project setup
|
||||||
$ npm run build
|
|
||||||
$ npm run start
|
|
||||||
|
|
||||||
# generate static project
|
Install dependencies by running the following command:
|
||||||
$ npm run generate
|
```shell
|
||||||
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Serve with hot reload at localhost:3000
|
||||||
|
```shell
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
Build for production
|
||||||
|
```shell
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
And to lint and fixe files, run:
|
||||||
|
```shell
|
||||||
|
npm run lint
|
||||||
|
```
|
||||||
For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).
|
For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).
|
||||||
|
## Contribute
|
||||||
|
**Pull requests are welcome !** Feel free to contribute.
|
||||||
|
|
||||||
|
### Add a tool
|
||||||
|
*Coming soon*
|
||||||
|
|
||||||
|
## Credits
|
||||||
|
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).
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue