From 39f90534560de6de41628b622ff70c1049cddd8f Mon Sep 17 00:00:00 2001 From: imfunny <36105478+imfunniee@users.noreply.github.com> Date: Wed, 8 May 2019 19:01:52 +0530 Subject: [PATCH] Update README.md --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index fa3fda2..3c61908 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,32 @@ # gitfolio portfolio website that showcases your work + +# Getting Started + +First of all you need to fork this repo as "your_username.github.io" + +``` +$ git clone "your repo you just forked" +$ cd "your repo name" +$ npm i +``` + +# Building + +``` +$ node build --name "your_username" +``` + +# Customizing + +To add your background image + +``` +$ node build --name "your github username" --background "background url" +``` + +To enable Dark theme + +``` +$ node build --name "your github username" --dark +```