Skip to content

Commit 95ee7f5

Browse files
authored
docs: readme
1 parent 4f49dd8 commit 95ee7f5

1 file changed

Lines changed: 53 additions & 2 deletions

File tree

README.md

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,53 @@
1-
# devprotocol.xyz
2-
Dev Protocol Website 2.0
1+
<!-- markdownlint-disable-next-line -->
2+
<div align="center"><p><a href="https://app.netlify.com/sites/devprotocol/deploys"><img src="https://img.shields.io/netlify/bddfebe4-8553-4de6-9ddb-522ce7f67842?style=flat-square&logo=netlify"></a> <a href="https://discord.gg/2S8PNMRQkq"><img src="https://img.shields.io/discord/835424705410236427?style=flat-square&logo=discord"></a> </p><br> <img height="70px" src="https://github.com/web3community/devprotocol.xyz/raw/main/public/assets/logo.png"><br><h1>devprotocol.xyz</h1><h5>Dev Protocol Website 2.0</h5><br><p><img src="https://user-images.githubusercontent.com/91655303/136316732-199891d1-9983-4370-b221-e972bc566d22.png" height="400"></p><p><a href="https://user-images.githubusercontent.com/91655303/136316732-199891d1-9983-4370-b221-e972bc566d22.png">View Deployed</a> · <a href="https://github.com/web3community/devprotocol.xyz/issues/new?assignees=&labels=bug&template=bug_report.yml&title=%5BBUG%5D+%3Cdescription%3E">Report a Bug</a></p></div>
3+
4+
## 🤓 Features
5+
6+
- [x] Uses modern web technologies
7+
- [x] Source code has support for writing in **Vue**, **React**, **Svelte** and/or **Preact**
8+
- [x] Source compiles into static html and css with no/little javascript
9+
- [x] Uses Tailwindcss for styling
10+
- [x] Handcrafted UI with UX in mind
11+
- [x] Accessible, Performant and SEO Optimized
12+
13+
## 🤔 I want to see a Deployed Version
14+
15+
This website is live hosted at: https://devprotocol.netlify.app.
16+
17+
## 🚀 Get It Running Quick
18+
19+
1. Skip all of the rest steps and use GitPod, which would automattically do all of this for you: [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/web3community/devprotocol.xyz)
20+
21+
2. Make sure you have the latest version of NodeJs Installed.
22+
23+
```sh
24+
node --version
25+
```
26+
27+
3. Install Dependencies
28+
29+
```sh
30+
npm install
31+
```
32+
33+
4. Start the app
34+
35+
```sh
36+
npm run start
37+
```
38+
39+
## 📦 Requirements
40+
41+
- [x] A latest version of [NodeJs](https://nodejs.org)
42+
43+
## ⌚ Coming Soon
44+
45+
Every contributor's efforts and time are deeply appreciated :smile:
46+
47+
Updates available at: https://github.com/web3community/devprotocol.xyz/projects/1
48+
49+
## 💖 Contributors
50+
51+
<a href = "https://github.com/web3community/devprotocol.xyz/graphs/contributors">
52+
<img src = "https://contrib.rocks/image?repo=web3community/devprotocol.xyz"/>
53+
</a>

0 commit comments

Comments
 (0)