Skip to content
This repository was archived by the owner on Jan 31, 2025. It is now read-only.

Commit 25c042e

Browse files
authored
Update README.md
1 parent cde688e commit 25c042e

File tree

1 file changed

+10
-33
lines changed

1 file changed

+10
-33
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 10 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,35 @@
1-
<h1 align="center">Block SDK 🧱</h1>
1+
# ⚠️ Block SDK - No Longer Maintained ⚠️
22

3-
<!-- markdownlint-disable MD013 -->
4-
<!-- markdownlint-disable MD041 -->
3+
🚨 **This project is no longer being maintained and will not be supported by current integrators.** If you wish to use this project, we strongly recommend forking and maintaining the code for any dependency or feature improvements you require. 🚨
54

6-
<div align="center">
7-
<a>
8-
<img alt="Logo" src="img/block-sdk.png" width="600">
9-
</a>
10-
</div>
5+
---
116

12-
<div align="center">
13-
<a>
14-
<img alt="Repo Status" src="https://www.repostatus.org/badges/latest/active.svg" />
15-
</a>
16-
<a>
17-
<img alt="License" src="https://img.shields.io/github/license/skip-mev/block-sdk.svg?style=flat-square" />
18-
</a>
19-
<a>
20-
<img alt="License" src="https://img.shields.io/badge/godoc-reference-blue?style=flat-square&logo=go" />
21-
</a>
22-
</div>
23-
24-
**Please note the status of BlockSDK maintenance:**
25-
26-
1. This project is no longer being maintained and will not be supported by current integrators. If you wish to use this project, we recommend forking and maintaining the code for any dependency or feature improvements you desire.
27-
28-
### πŸ€”Β What is the Block SDK?
29-
30-
**🌐 The Block SDK is a toolkit for building customized blocks**. The Block SDK is a set of Cosmos SDK and ABCI++ primitives that allow chains to fully customize blocks to specific use cases. It turns your chain's blocks into a **`highway`** consisting of individual **`lanes`** with their own special functionality.
7+
## πŸ€” What is the Block SDK?
318

9+
**🌐 The Block SDK is a toolkit for building customized blocks.** The Block SDK is a set of Cosmos SDK and ABCI++ primitives that allow chains to fully customize blocks to specific use cases. It turns your chain's blocks into a **`highway`** consisting of individual **`lanes`** with their own special functionality.
3210

3311
Skip has built out a number of plug-and-play `lanes` on the SDK that your protocol can use, including in-protocol MEV recapture and Oracles! Additionally, the Block SDK can be extended to add **your own custom `lanes`** to configure your blocks to exactly fit your application needs.
3412

35-
### Release Compatibility Matrix
13+
## Release Compatibility Matrix
3614

3715
| Block SDK Version | Cosmos SDK |
3816
| :---------: | :--------: |
3917
| `v1.x.x` | `v0.47.x` |
4018
| `v2.x.x` | `v0.50.x` |
4119

42-
43-
### πŸ“š Block SDK Documentation
20+
## πŸ“š Block SDK Documentation
4421

4522
To read more about how the Block SDK works, check out the [How it Works](https://docs.skip.money/blocksdk/overview).
4623

47-
#### πŸͺ Lane App Store
24+
### πŸͺ Lane App Store
4825

4926
To read more about Skip's pre-built `lanes` and how to use them, check out the [Lane App Store](https://docs.skip.money/blocksdk/lanes/existing-lanes/mev).
5027

51-
#### 🎨 Lane Development
28+
### 🎨 Lane Development
5229

5330
To read more about how to build your own custom `lanes`, check out the [Build Your Own Lane](https://docs.skip.money/blocksdk/lanes/build-your-own-lane).
5431

55-
### Audits
32+
## Audits
5633

5734
The Block SDK has undergone audits by the following firms:
5835

0 commit comments

Comments
Β (0)