diff --git a/README.md b/README.md index 0e1d9c2..aea9f80 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,43 @@ # Portfolio -Created with Next js, typescript, chakra UI and framer motion with ESLint +[![Website](https://img.shields.io/website?label=Website&url=https://nishchay17.vercel.app/)](https://nishchay17.vercel.app/) [![GitHub License](https://img.shields.io/github/license/nishchay17/teams-frontend-v2)](https://github.com/nishchay17/portfolio/blob/main/LICENSE) + + +## Table of Contents + +- [About](#about) +- [Features](#features) +- [Getting Started](#getting-started) +- [License](#license) + +## About + +This is my Portfolio for showcasing all my personal projects, created with Next js, typescript, chakra UI, and framer motion with ESLint + +## Features + +1. **Dynamic project description**: Fetches project description directly from Github readme file to display it in the project section of the website. + +2. **Animations**: Uses Framer motion of animate elements in and out of view. + +## Getting Started + +To get started with our website, follow these steps: + +```bash +# Clone the repository +git clone https://github.com/nishchay17/portfolio.git + +# Change directory +cd portfolio + +# Install dependencies +yarn + +# Start the development server +yarn dev +``` + +## License + +This project is licensed under the [MIT License](https://github.com/nishchay17/portfolio/blob/main/LICENSE).