MD file setup

Author: zlrundefined

README.md

@@ -1,29 +1,31 @@
-# Clean Vue.js & TailwindCSS Portfolio Template
+# Vuejs & TailwindCSS Portfolio - With Dark Mode
 
-## Project setup
+A simple portfolio starter theme built on the top of Vue.js V3 and TailwindCSS V2
 
-```
-npm install
-```
+## Demo URL
 
-### Compiles and hot-reloads for development
+[https://vuejs-tailwindcss-portfolio.netlify.com](https://vuejs-tailwindcss-portfolio.netlify.com)
 
-```
-npm run serve
-```
+## Features
 
-### Compiles and minifies for production
+-   Simple and responsive design
+-   [Tailwind CSS v2](https://tailwindcss.com) (with PurgeCSS)
+-   [Vue.js v3](https://vuejs.org) with [Vue Router](https://router.vuejs.org)
+-   Theme Switcher with Dark Mode
+-   Smoth Scroll
+-   Projects Carousel
 
-```
-npm run build
-```
+## Installation
 
-### Lints and fixes files
+1. Make sure you have Node JS installed. If you don't have it: `npm install --global @gridsome/cli`
+1. Make sure you have Vue CLI installed. If you don't have it: `npm install --global @gridsome/cli`
+1. Clone the repo: `git clone https://github.com/NangialaiStoman/vuejs-tailwindcss-portfolio.git`
+1. `cd vuejs-tailwindcss-portfolio`
+1. `npm install`
+1. `npm run serve` to start a local dev server at `http://localhost:8080`
 
-```
-npm run lint
-```
+## Notes
 
-### Customize configuration
-
-See [Configuration Reference](https://cli.vuejs.org/config/).
+-   The dark mode is highly inspired by [Gridsome Portfolio Starter by Andre Madarang](https://github.com/drehimself/gridsome-portfolio-starter). Since the project is based on Gridsome, I wanted to create a pure Vue.js and TailwindCSS version of it
+-   Check out a [screencast I did](https://www.youtube.com/) where I go through the process of building this portfolio (Coming Soon).
+-   Illustrations from [unDraw](https://undraw.co)