Skip to content

Commit

Permalink
docs: 📝 Added README template for future documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
antiyro committed Jan 4, 2024
1 parent 2c8356c commit dd60e66
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- markdownlint-disable -->
<div align="center">
<img src="https://github.com/KasarLabs/brand/blob/main/projects/deoxys/logo.png?raw=true" height="256" style="border-radius: 15px;">
<img src="https://github.com/KasarLabs/brand/blob/main/projects/deoxys/logo.png?raw=true" height="200" style="border-radius: 15px;">
</div>
<div align="center">
<br />
Expand All @@ -17,3 +17,32 @@
</div>

# 👽 Deoxys: Starknet full node client on Substrate

## ⚙️ Installation

### Prerequisites

### Build and Run

### Run with Docker

## 📸 Snapshots

### Run Deoxys Using Snapshot

After following these steps, Deoxys should be up and running on your machine, utilizing the provided snapshot.

## ✔ Supported Features

## 👍 Contribute

## 🤝 Partnerships

To establish a partnership with the Kasar team, or if you have any suggestion or special request, feel free to reach us
on [telegram](https://t.me/kasarlabs).

## ⚠️ License

Copyright (c) 2022-present, with the following [contributors](https://github.com/KasarLabs/deoxys/graphs/contributors).

Deoxys is open-source software licensed under the [Apache-2.0 License](https://github.com/KasarLabs/deoxys/blob/main/LICENSE).

0 comments on commit dd60e66

Please sign in to comment.