Skip to content

Commit 52d3df7

Browse files
committed
Added README
1 parent 6960d32 commit 52d3df7

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

README.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<!-- markdownlint-disable -->
2+
<div align="center">
3+
<img src="https://protokit.dev/logo-dark.svg" height="128">
4+
</div>
5+
<div align="center">
6+
<br />
7+
<!-- markdownlint-restore -->
8+
9+
[![npm version](https://img.shields.io/npm/v/@proto-kit/sdk.svg?style=flat&logo=npm)](https://www.npmjs.com/package/o1js)
10+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg)]()
11+
12+
[![PRs Welcome](https://img.shields.io/badge/Documentation-website-green.svg)](https://protokit.dev)
13+
[![Discord](https://img.shields.io/discord/1155929817070436362?color=green&logo=discord)](https://discord.gg/xdGf2ucppM)
14+
15+
</div>
16+
17+
# 🚧 Protokit App Chain Framework
18+
19+
Welcome to the Protokit repository, a protocol development framework for privacy enabled application chains.
20+
21+
Protokit enables developers to build zero-knowledge, interoperable and privacy preserving application chains with a minimal learning curve.
22+
23+
## 📖 Documentation
24+
25+
Find the documentation for protokit on [our website](https://protokit.dev)
26+
27+
## ⚡ Features
28+
29+
- 🔐 Privacy Enabled
30+
- ♾️ Succint zkVM
31+
- 🖥️ Supercharged DevX
32+
- 🔧 Modular
33+
- 🤝 Interoperable
34+
35+
## 📜 Other repositories
36+
37+
- [Starter kit](https://github.com/proto-kit/starter-kit): Our starter kit, which serves as a starting point for any new protokit projects.
38+
- [Private Airdrop Workshop](https://github.com/proto-kit/private-airdrop-workshop): Sources for the workshop we held, that showcases protokit and its features.
39+
40+
## ▶️ Quickstart
41+
42+
The fastest way to start building with Protokit is to use the [starter kit](https://github.com/proto-kit/starter-kit).
43+
The starter kit provides a [monorepo](https://en.wikipedia.org/wiki/Monorepo1) aimed at kickstarting application chain development using the Protokit framework.
44+
45+
<Steps>
46+
### Install dependencies
47+
48+
Before you can start building with Protokit, you need to install the following dependencies:
49+
50+
- [Node.js v18](https://nodejs.org/en)
51+
- [pnpm](https://pnpm.io)
52+
- [nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
53+
54+
### Clone the starter kit
55+
56+
```bash
57+
# Clone the starter kit
58+
git clone https://github.com/proto-kit/starter-kit my-chain
59+
cd my-chain
60+
61+
# Ensure you're on the right nodejs version and install dependnecies
62+
nvm use
63+
pnpm install
64+
```
65+
66+
### Run the tests
67+
68+
```bash
69+
# run and watch tests for the `chain` package
70+
pnpm run test --filter=chain -- --watchAll
71+
```
72+
73+
74+
## 📚 License
75+
76+
This project is under the Apache License 2.0.
77+
78+
See [LICENSE](LICENSE.md) for more information.

0 commit comments

Comments
 (0)