Skip to content

docs: update readme #340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
delta1 wants to merge 1 commit into
base: master
Choose a base branch
from
+18 −2
Open

docs: update readme #340

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,24 @@
# Simplicity

Simplicity is a blockchain programming language designed as an alternative to Bitcoin script.
> [!IMPORTANT]
> The Simplicity language and implementation are still under development.

The language and implementation is still under development.
[Simplicity](https://simplicity-lang.org/) is a blockchain programming language designed as an alternative to Bitcoin script.

It is a low-level, typed functional language designed to be a drop-in alternative
for Bitcoin's [Tapscript](https://github.com/bitcoin/bips/blob/master/bip-0342.mediawiki).
It offers static resource bounds and has a formal specification (in Rocq) which allows the
creation of machine-checkable proofs of program behavior.

It is currently deployed on Blockstream's [Liquid](https://liquid.net), which is a sidechain resembling Bitcoin
in many ways; but which differs in many Script-relevant ways (e.g. supporting multiple
assets and using Confidential Transactions).

This repo is the core Haskell and C implementation of Simplicity (AKA libSimplicity).

If you are simply looking to develop with the
language, you may wish to use [SimplicityHL](https://github.com/BlockstreamResearch/simplicityhl), or [rust-simplicity](https://github.com/BlockstreamResearch/rust-simplicity)
instead.

## Contents

Expand Down
Loading