Skip to content

Commit

Permalink
doc: reference Go documentation in README
Browse files Browse the repository at this point in the history
  • Loading branch information
ARR4N committed Feb 29, 2024
1 parent 9f90cf9 commit 8f32ddf
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SpecialOps [![Go](https://github.com/solidifylabs/specialops/actions/workflows/go.yml/badge.svg)](https://github.com/solidifylabs/specialops/actions/workflows/go.yml) [![Go Reference](https://pkg.go.dev/badge/github.com/solidifylabs/specialops.svg)](https://pkg.go.dev/github.com/solidifylabs/specialops)

> `specialops` is a low-level, domain-specific language for crafting [Ethereum VM](https://ethereum.org/en/developers/docs/evm) bytecode in Go.
> `specialops` is a low-level, domain-specific language (and compiler) for crafting [Ethereum VM](https://ethereum.org/en/developers/docs/evm) bytecode in Go.
This is a _very_ early release. In fact, it's just a weekend project gone rogue
so is less than a week old.
Expand Down Expand Up @@ -31,6 +31,12 @@ bytecode unchanged.
- [ ] Standalone compiler
- [ ] Interactive debugger

### Documentation

The [`specialops` Go
documentation](https://pkg.go.dev/github.com/solidifylabs/specialops) covers all
functionality.

## Examples

### Hello world
Expand Down

0 comments on commit 8f32ddf

Please sign in to comment.