Skip to content

Commit cfdeb26

Browse files
committed
💄 Update README
1 parent d84f1e1 commit cfdeb26

File tree

1 file changed

+42
-20
lines changed

1 file changed

+42
-20
lines changed

README.md

Lines changed: 42 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,49 @@
1-
# Skypier VPN
1+
<p align="center">
2+
<a href="https://skypier.io/#gh-light-mode-only">
3+
<img src="https://skypier.io/skypier_logo_baseline.png" width="318px" alt="skypier logo" />
4+
</a>
5+
<a href="https://skypier.io/#gh-dark-mode-only">
6+
<img src="https://skypier.io/_astro/skypier_baseline.9f3ab695.svg" width="318px" alt="skypier logo" />
7+
</a>
8+
</p>
29

3-
decentralized VPN POC
10+
<h3 align="center">
11+
Skypier VPN | Decentralized built on top of libp2p
12+
</h3>
13+
<p align="center">
14+
A more equitable and scalable decentralized network platform that empowers people the freedom to express and explore anonymously without worry of compromising their privacy or quality of access.
15+
</p>
16+
<p align="center">
17+
<a href="https://skypier.io">Official website</a>・
18+
<a href="https://skypier.io">Twitter/X</a>
19+
</p>
20+
<br />
421

5-
## Build and Run (on Linux)
22+
<p align="center">
23+
<a href="#">
24+
<img src="https://img.shields.io/github/followers/SkyPierIO" alt="Github followers" />
25+
</a>
26+
<a href="https://twitter.com/SkypierIO">
27+
<img src="https://img.shields.io/twitter/follow/SkypierIO" alt="Twitter" />
28+
</a>
29+
<a href="https://github.com/SkyPierIO">
30+
<img src="https://img.shields.io/github/license/SkyPierIO/SkyPierUI" alt="license" />
31+
</a>
32+
</p>
33+
34+
<hr>
35+
36+
## Build from sources
637

738
```bash
839
go build -o build/skypier-vpn-node cmd/skypier-vpn-node/main.go
9-
sudo ./build/skypier-vpn-node
1040
```
1141

12-
## TODO list
13-
14-
- [x] Init libp2p node
15-
- [x] Init REST API (Gin)
16-
- [x] Read config file
17-
- [x] Init TUN interface on Linux
18-
- [ ] Init TUN interface on Darwin
19-
- [ ] Init TUN interface on Windows
20-
- [x] If "privateKey" is given in the config, bootsrap the node using this private key
21-
- [x] Launch web UI at launch
22-
- [x] Enable QUIC protocol
23-
- [ ] Add some dynamic frontend build using Github Action
24-
- [ ] Ensure QUIC protocol first (need more test)
25-
- [ ] Check remote peer is reachable
26-
- [ ] Mount tunnel with remote address corresponding to this peer ID (check the DHT)
27-
- [ ] Config validated with a JsonSchema
42+
## Install pre-built binary
43+
44+
1. Get the latest release for your Operating System [here](#)
45+
2. Run the installation script
46+
47+
```bash
48+
sudo ./install.sh
49+
```

0 commit comments

Comments
 (0)