Skip to content

Commit a0a88ee

Browse files
authored
Update README.md
1 parent 7e7774a commit a0a88ee

1 file changed

Lines changed: 41 additions & 5 deletions

File tree

README.md

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,23 @@
1-
# **[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)**
1+
<div align=center>
2+
3+
<br>
4+
5+
<img height=70 src="https://raw.githubusercontent.com/javaistic/.github/main/profile/img/logo-light.svg#gh-dark-mode-only">
6+
<img height=70 src="https://raw.githubusercontent.com/javaistic/.github/main/profile/img/logo-dark.svg#gh-light-mode-only">
7+
8+
9+
# ![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)
10+
11+
</div>
212

313
<div align="center">
414

515
[![javaistic](.github/img/javaistic-readme.png)](https://javaistic.vercel.app/?utm_source=github&utm_medium=readme-image&utm_campaign=javaistic)
616

7-
### **Javaistic - Java learning made simple.**
817

918
</div>
1019

11-
## **Website : [javaistic.vercel.app](https://javaistic.vercel.app/?utm_source=github&utm_medium=readme-link&utm_campaign=javaistic)**
20+
## **Website [javaistic.vercel.app](https://javaistic.vercel.app/?utm_source=github&utm_medium=readme-link&utm_campaign=javaistic)**
1221

1322
## **[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)**
1423

@@ -22,10 +31,37 @@
2231

2332
A Java Programming learning website packed with information and programs ranging from basics , arrays , string programs to 2D arrays , recursion , matrices and many more.
2433

25-
## **[License](LICENSE)**
34+
## **Contributing**
35+
If you're interested in contributing to Javaistic Documentation, please read our contributing docs before submitting a pull request.
36+
37+
## For developing locally
38+
39+
Javaistic uses [Next.js](https://nextjs.org/) for its documentation. Here is how you can run the project locally:
40+
41+
1. Clone this repo
42+
43+
```sh
44+
git clone https://github.com/javaistic/javaistic.git
45+
```
46+
47+
2. Go into the project root directory
48+
49+
```sh
50+
cd javaistic
51+
```
52+
53+
3. Install JS dependencies
54+
55+
```sh
56+
yarn
57+
```
2658

27-
![License](https://badgen.net/github/license/javaistic/javaistic)
59+
4. Start the dev server
2860

61+
```sh
62+
yarn dev
63+
```
64+
2965
## **Sponsors**
3066

3167
A special thanks to our sponsors:

0 commit comments

Comments
 (0)