Skip to content

Update README.md #79

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

Merged
merged 1 commit into from
Mar 4, 2025
Merged

Update README.md #79

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
15 changes: 6 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Checkout [releases](https://github.com/spacesprotocol/spaces/releases) for an im

Spaces are sovereign Bitcoin identities. They leverage the existing infrastructure and security of Bitcoin without requiring a new blockchain or any modifications to Bitcoin itself [learn more](https://spacesprotocol.org).


`spaced` is a tiny layer that connects to Bitcoin Core over RPC and scans transactions relevant to the protocol.

`space-cli` is a Bitcoin wallet that supports opening auctions, bidding and registering spaces.
Expand All @@ -19,15 +18,14 @@ Paste the following into your terminal to install the latest version of Spaces:
curl --proto '=https' --tlsv1.2 -sSf https://install.spacesprotocol.org | sh
```

## Documentation

## Development setup on testnet4
Visit [docs](https://spacesprotocol.org/) to learn how to get started.

### Install Bitcoin Core
Bitcoin Core of version 28+ is required. It can be installed from the official [download page](https://bitcoincore.org/en/download/).

### Install Spaces Daemon
## Build from source

`spaced` is a tiny layer that connects to Bitcoin Core over RPC and scans transactions relevant to the protocol. Make sure you have [Rust](https://www.rust-lang.org/tools/install) installed before proceeding.
To build it from source:

```sh
git clone https://github.com/spacesprotocol/spaced && cd spaced
Expand All @@ -48,6 +46,8 @@ spaced --version
space-cli --version
```

## Development setup on testnet4

### Setup

First, download Bitcoin Core and set it up to connect to `testnet4` using these steps:
Expand Down Expand Up @@ -78,9 +78,6 @@ spaced --chain testnet4 --bitcoin-rpc-user testnet4 --bitcoin-rpc-password testn
| protocol | No | Protocol consensus library |
| veritas | No | Stateless verifier library for mobile and other resource constrained devices with wasm support. |

## Documentation

Visit [docs](https://docs.spacesprotocol.org/) to get more information about Spaces protocol.


## License
Expand Down
Loading