Skip to content

Commit 20786c2

Browse files
authored
docs: add more information to the readme (#158)
1 parent ab88f16 commit 20786c2

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
1-
# Network Simulator
1+
# GEduNet 🌐
2+
3+
_GEduNet_ is an Graphical Educational Computer Network Simulator.
4+
It's meant as an aid to students trying to understand computer networks, along with their teachers.
5+
6+
The project runs on the browser and is hosted in GitHub Pages.
7+
You can access it [here](https://megaredhand.github.io/network-simulator/).
8+
9+
## How to use
10+
11+
🏗️ This part is a work-in-progress 🏗️
12+
13+
![Preview of the simulator. Shows multiple hosts, routers and switches. Some network packets are being sent through the network.](./img/full-preview.png)
14+
15+
Pressing one of the buttons on the left bar adds the device shown on the image to the network.
16+
The right bar presents information on the currently selected device.
17+
18+
## Development
219

320
To run the local development server, use `npm run start`
421

522
For building the artifacts, use `npm run build`
23+
24+
For checking code format and lint, use `npm run lint`

img/full-preview.png

97.7 KB
Loading

0 commit comments

Comments
 (0)