From 6b1e53fae571b5b0fea39eaf431d0b871c288653 Mon Sep 17 00:00:00 2001 From: Adarsh Madrecha Date: Thu, 18 Feb 2021 21:43:03 +0530 Subject: [PATCH] updated readme --- README.md | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 5d3f683..12ef012 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,25 @@ # marwaridictionary +This repository contains source code and content for marwaridictionary.org ## Build Setup +> If you wish to contribute to this project, follow these steps -```bash -# install dependencies -$ npm install +1. Fork the repo +1. Setup for local environment -# serve with hot reload at localhost:3000 -$ npm run dev + ```bash + # install dependencies + $ npm install -# build for production and launch server -$ npm run build -$ npm run start + # serve with hot reload at localhost:3000 + $ npm run dev -# generate static project -$ npm run generate -``` + # build for production and launch server + $ npm run build + $ npm run start -For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org). + # generate static project + $ npm run generate + ``` + + For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).