Skip to content

Commit 6f20075

Browse files
buffrrrandomlogin
andcommitted
Update README.md
Co-authored-by: Alexander Shevtsov <[email protected]>
1 parent 5633421 commit 6f20075

File tree

2 files changed

+88
-23
lines changed

2 files changed

+88
-23
lines changed

LICENSE

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2009-2024 The Bitcoin Core developers
4+
Copyright (c) 2009-2024 Bitcoin Developers
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy
7+
of this software and associated documentation files (the "Software"), to deal
8+
in the Software without restriction, including without limitation the rights
9+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
copies of the Software, and to permit persons to whom the Software is
11+
furnished to do so, subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in
14+
all copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22+
THE SOFTWARE.

README.md

+66-23
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,78 @@
1-
# Spaced - Bitcoin Spaces daemon
1+
# Bitcoin Spaces
22

3-
Spaces is a naming protocol that leverages the existing infrastructure and security of Bitcoin without requiring a new blockchain or any modifications to Bitcoin itself [learn more](https://spacesprotocol.org).
3+
Checkout [releases](https://github.com/spacesprotocol/spaces/releases) for an immediately usable binary version of this software.
44

5-
## Project Structure
65

7-
| Package | Requires std | Description |
8-
|----------|------------------|------------------------------------------------|
9-
| node | Yes | Daemon and wallet service |
10-
| wallet | Yes (no-std WIP) | wallet library for building spaces transactions|
11-
| protocol | No | Protocol consensus library |
6+
## What does it do?
127

13-
## Setup
8+
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).
149

15-
First, download Bitcoin Core and set it up to connect to `regtest`
16-
using these steps:
1710

18-
```bash
19-
# Create a directory for Bitcoin regtest data
20-
mkdir $HOME/bitcoin-regtest
21-
echo "rpcuser=test" > $HOME/bitcoin-regtest/bitcoin.conf
22-
echo "rpcpassword=test" >> $HOME/bitcoin-regtest/bitcoin.conf
23-
bitcoind -regtest -datadir=$HOME/bitcoin-regtest
24-
```
11+
`spaced` is a tiny layer that connects to Bitcoin Core over RPC and scans transactions relevant to the protocol.
12+
13+
`space-cli` is a Bitcoin wallet that supports opening auctions, bidding and registering spaces.
14+
15+
## Quick Start
16+
17+
Check out the [documentation](httsp://docs.spacesprotocol.org)
2518

26-
```bash
19+
## Development setup on testnet4
20+
21+
### Install Bitcoin Core
22+
Bitcoin Core of version 28+ is required. It can be installed from the official [download page](https://bitcoincore.org/en/download/).
23+
24+
### Install Spaces Daemon
25+
26+
`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.
27+
28+
```sh
2729
git clone https://github.com/spacesprotocol/spaced && cd spaced
28-
cargo build
30+
cargo install --path node --locked
2931
```
3032

31-
Connect `spaced` to Bitcoin core
33+
Make sure it's in your path
3234

33-
```bash
34-
spaced --chain regtest --bitcoin-rpc-user test --bitcoin-rpc-password test
35+
```sh
36+
echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.bashrc
37+
source ~/.bashrc
3538
```
39+
40+
Verify installation
41+
42+
```
43+
spaced --version
44+
space-cli --version
45+
```
46+
47+
### Setup
48+
49+
First, download Bitcoin Core and set it up to connect to `testnet4` using these steps:
50+
51+
```sh
52+
mkdir $HOME/bitcoin-testnet4
53+
54+
# Create a configuration file with RPC credentials
55+
echo "rpcuser=testnet4" > $HOME/bitcoin-testnet4/bitcoin.conf
56+
echo "rpcpassword=testnet4" >> $HOME/bitcoin-testnet4/bitcoin.conf
57+
58+
# Start Bitcoin Core specifying testnet4 network
59+
bitcoind -testnet4 -datadir=$HOME/bitcoin-testnet4
60+
```
61+
62+
Next, run spaced with the following:
63+
```sh
64+
spaced --chain testnet4 --bitcoin-rpc-user testnet4 --bitcoin-rpc-password testnet4
65+
```
66+
67+
## Project Structure
68+
69+
| Package | Requires std | Description |
70+
|----------|------------------|------------------------------------------------|
71+
| node | Yes | Daemon and wallet service |
72+
| wallet | Yes (no-std WIP) | wallet library for building spaces transactions|
73+
| protocol | No | Protocol consensus library |
74+
75+
76+
## License
77+
78+
Spaces is released under the terms of the MIT license. See LICENSE for more information or see https://opensource.org/licenses/MIT.

0 commit comments

Comments
 (0)