chore: update docs

This commit is contained in:
OmitNomis 2023-12-29 21:35:27 +05:45
parent 478cd8582e
commit c4b2cc4623

View File

@ -6,6 +6,14 @@ Simple web app that renders minimalist CV with print-friendly layout.
Built with Next.js and shadcn/ui, deployed on Vercel.
# Features
- Setup only takes a few minutes [single config file](./src/data/resume-data.tsx)
- Built using Next.js 14, React, Typescript, Shadcn/ui, TailwindCss
- Auto generated Layout
- Responsive for different devices
- Optimized for Next.js and Vercel
# Getting Started Locally
1. Clone this repository to your local machine:
@ -13,17 +21,27 @@ Built with Next.js and shadcn/ui, deployed on Vercel.
```bash
git clone https://github.com/BartoszJarocki/cv.git
```
2. Move to the cloned directory
```bash
cd cv
```
3. Install dependencies:
```bash
yarn install
```
4. Start the local Server:
```bash
yarn dev
```
5. Open the [Config file](./src/data/resume-data.tsx) and make changes
# License
[MIT](https://choosealicense.com/licenses/mit/)