Skip to content

Commit

Permalink
📝 README
Browse files Browse the repository at this point in the history
  • Loading branch information
clabby committed Sep 22, 2023
1 parent 7d136ce commit c8e4622
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 5 deletions.
35 changes: 30 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,33 @@
<img align="right" width="150" height="150" top="100" src="./assets/logo.png">

# `cannon-rs`[![ci](https://github.com/clabby/cannon-rs/actions/workflows/ci.yaml/badge.svg?label=ci)](https://github.com/clabby/cannon-rs/actions/workflows/ci.yaml) ![license](https://img.shields.io/badge/License-MIT-green.svg?label=license)

`cannon-rs` is an alternative implementation of [Cannon][cannon] in Rust.
<h1 align="center">
<br>
<img src="./assets/banner.png" alt="Markdownify" height="350">
<br>
<code>cannon-rs</code>
<br>
</h1>

<h4 align="center">
An alternative implementation of the OP Stack's <a href="https://github.com/ethereum-optimism/optimism/tree/develop/cannon">Cannon</a> in Rust.
</h4>

<p align="center">
<a href="https://github.com/clabby/cannon-rs/actions/workflows/ci.yaml">
<img src="https://github.com/clabby/cannon-rs/actions/workflows/ci.yaml/badge.svg?label=ci" alt="Ci">
</a>
<img src="https://img.shields.io/badge/License-MIT-green.svg?label=license" alt="License">
<a href="https://github.com/ethereum-optimism/monorepo"><img src="https://img.shields.io/badge/OP%20Stack-monorepo-red" alt="OP Stack"></a>
</p>

<p align="center">
<a href="#whats-a-cannon">What's a Cannon?</a> •
<a href="#credits">Credits</a> •
<a href="#usage">Usage</a> •
<a href="#contributing">Contributing</a> •
<a href="#documentation">Documentation</a> •
<a href="#docker">Docker</a>
</p>

## What's a Cannon?

* It's Rust code
* ...that was originally Go code
Expand Down
Binary file added assets/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/logo.png
Binary file not shown.

0 comments on commit c8e4622

Please sign in to comment.