From 46f78e3c97616c0a77658a4286c9d21caa1ab774 Mon Sep 17 00:00:00 2001
From: Yash Dave <connect@amorpheuz.dev>
Date: Mon, 17 May 2021 01:22:14 +0530
Subject: [PATCH] Update Readme and add contributing guidelines

---
 CONTRIBUTING.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 README.md       | 36 +++++++++++++++++++++++++++++-------
 2 files changed, 73 insertions(+), 7 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..e9c3d7f
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,44 @@
+# Contributing Guidelines
+
+Thank you for showing interest in contributing to the project. ♥️
+
+Please follow the instructions below:
+
+## ISSUES 🐛
+
+When you're creating a new issue make sure to share as much information as you can. This helps to better understand the issue and fix/add new features quickly.
+
+- Open an issue if you found a bug.
+- If you want me to add any missing feature, please open an issue.
+
+## GitHub Workflow
+
+1. Fork the repository.
+2. Clone the forked repository using the command.
+
+   ```bash
+   git clone https://github.com/<YOUR-USERNAME>/fur-miliar.git
+   ```
+
+3. Create a new branch. If you're fixing a bug start the branch name with `fix/` **OR** if you're adding a new feature start the branch name with `feature/`.
+
+   ```bash
+   git checkout -b (fix|feature)/<WHAT-YOU-FIXED>
+   ```
+
+4. Make changes. Commit the changes with a relevant commit message.
+
+   ```bash
+   git add . // or file name
+   git commit -m '<WHAT-WAS-THE-CHANGE>'
+   ```
+
+5. Push the changes to GitHub.
+
+   ```bash
+   git push -u origin <branch-name>
+   ```
+
+6. Create a Pull Request.
+
+Thanks! 😁
diff --git a/README.md b/README.md
index 3b94a5a..25afb65 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,42 @@
-# fetch-cat-breeds
+<!-- markdownlint-disable MD033 -->
 
-## Build Setup
+# Fur~miliar
+
+Fur<span aria-hidden="true">~</span>miliar is a Vue.js app built using Nuxt.js that allows users to search and learn more about various cat breeds. Checkout the project at [https://furmiliar.amorpheuz.dev/](https://furmiliar.amorpheuz.dev/)!
+
+## Tools Used
+
+- [Vue.js](https://vuejs.org/)
+- [NuxtJS](https://nuxtjs.org/)
+- [Tailwind CSS](https://tailwindcss.com/)
+- [The Cat API](https://thecatapi.com/)
+- [Vercel](https://vercel.com/)
+
+## Getting Started
+
+### Prerequisites
+
+This project is built with `Node.js` and `Yarn v1`. Before setting up the project, [install Node.js](https://nodejs.org/en/download/) and then [install Yarn v1](https://classic.yarnpkg.com/en/docs/install) to get started.
+
+### Setup Fur~miliar
 
 ```bash
-# install dependencies
+# 1. install dependencies
 $ yarn install
 
-# serve with hot reload at localhost:3000
+# 2. serve with hot reload at localhost:3000
 $ yarn dev
 
-# build for production and launch server
+# 3. build for production and launch server
 $ yarn build
 $ yarn start
 
-# generate static project
+# OR
+
+# 3. generate static project
 $ yarn generate
 ```
 
-For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).
+## Contribute
+
+If you would like to contribute to the project, please check out the [contributing](./CONTRIBUTING.md) docs.