From f05a98b074c6d9eed97ca52327766d7ec37f3ec0 Mon Sep 17 00:00:00 2001 From: NetMan <13informatyka14@gmail.com> Date: Mon, 3 Mar 2025 19:50:51 +0100 Subject: [PATCH] readme & license --- LICENSE | 21 +++++++++++++++++++++ README.md | 56 ++++++++++--------------------------------------------- 2 files changed, 31 insertions(+), 46 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8028920 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 NetMan + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 25b5821..33702e8 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,21 @@ -# Nuxt Minimal Starter - -Look at the [Nuxt documentation](https://nuxt.com/docs/getting-started/introduction) to learn more. +# nuxt-prawo-jazdy ## Setup -Make sure to install dependencies: +This project utilizes `pnpm`, thus it is recommended ```bash -# npm -npm install - -# pnpm pnpm install - -# yarn -yarn install - -# bun -bun install ``` +More information about setting up database will come here later + ## Development Server Start the development server on `http://localhost:3000`: ```bash -# npm -npm run dev - -# pnpm -pnpm dev - -# yarn -yarn dev - -# bun -bun run dev +pnpm run dev ``` ## Production @@ -43,33 +23,17 @@ bun run dev Build the application for production: ```bash -# npm -npm run build - -# pnpm pnpm build - -# yarn -yarn build - -# bun -bun run build ``` Locally preview production build: ```bash -# npm -npm run preview - -# pnpm pnpm preview - -# yarn -yarn preview - -# bun -bun run preview ``` -Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information. +Check out the [Nuxt documentation](https://nuxt.com/docs) for more information. + +### Licensing + +Distributed via [MIT License](./LICENSE)