Update README.md

javaistic · uiuxarghya · Jan 9, 2022 · Dec 26, 2021 · Jan 9, 2022 · Jan 9, 2022
commit a0a88ee4dfeaccceeb8d9cb2a0c91a680d119748
diff --git a/README.md b/README.md
@@ -1,14 +1,23 @@
-# **[Javaistic](https://javaistic.vercel.app/?utm_source=github&utm_medium=readme-header&utm_campaign=javaistic) ![Stars](https://badgen.net/github/stars/javaistic/javaistic) ![Release](https://badgen.net/github/release/javaistic/javaistic) [![CodeQL](https://github.com/javaistic/javaistic/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/javaistic/javaistic/actions/workflows/codeql-analysis.yml)**
+<div align=center>
+
+<br>
+
+<img height=70 src="https://raw.githubusercontent.com/javaistic/.github/main/profile/img/logo-light.svg#gh-dark-mode-only">
+<img height=70 src="https://raw.githubusercontent.com/javaistic/.github/main/profile/img/logo-dark.svg#gh-light-mode-only">
+
+
+# ![Stars](https://badgen.net/github/stars/javaistic/javaistic) ![Release](https://badgen.net/github/release/javaistic/javaistic) [![CodeQL](https://github.com/javaistic/javaistic/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/javaistic/javaistic/actions/workflows/codeql-analysis.yml) [![License](https://badgen.net/github/license/javaistic/javaistic)](LICENSE)
+
+</div>
 
 <div align="center">
 
 [![javaistic](.github/img/javaistic-readme.png)](https://javaistic.vercel.app/?utm_source=github&utm_medium=readme-image&utm_campaign=javaistic)
 
-### **Javaistic - Java learning made simple.**
 
 </div>
 
-## **Website : [javaistic.vercel.app](https://javaistic.vercel.app/?utm_source=github&utm_medium=readme-link&utm_campaign=javaistic)**
+## **Website ⟶ [javaistic.vercel.app](https://javaistic.vercel.app/?utm_source=github&utm_medium=readme-link&utm_campaign=javaistic)**
 
 ## **[Site Status](https://javaistic.betteruptime.com/) [![Better Uptime Badge](https://betteruptime.com/status-badges/v1/monitor/8a3u.svg)](https://betteruptime.com/?utm_source=status_badge)**
 
@@ -22,10 +31,37 @@
 
 A Java Programming learning website packed with information and programs ranging from basics , arrays , string programs to 2D arrays , recursion , matrices and many more.
 
-## **[License](LICENSE)**
+## **Contributing**
+If you're interested in contributing to Javaistic Documentation, please read our contributing docs before submitting a pull request.
+
+## For developing locally
+
+Javaistic uses [Next.js](https://nextjs.org/) for its documentation. Here is how you can run the project locally:
+
+1. Clone this repo
+
+    ```sh
+    git clone https://github.com/javaistic/javaistic.git
+    ```
+
+2. Go into the project root directory
+
+    ```sh
+    cd javaistic
+    ```
+
+3. Install JS dependencies
+
+    ```sh
+    yarn
+    ```
 
-![License](https://badgen.net/github/license/javaistic/javaistic)
+4. Start the dev server
 
+    ```sh
+    yarn dev
+    ```
+
 ## **Sponsors**
 
 A special thanks to our sponsors: