Skip to content

Commit

Permalink
doc: Clarify readme
Browse files Browse the repository at this point in the history
  • Loading branch information
HeinrichApfelmus committed Jul 21, 2023
1 parent 9215d9c commit a6896a2
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@

## Overview

Cardano Wallet helps you manage your Ada. You can use it to send and
receive payments on the [Cardano](https://www.cardano.org) blockchain.
Cardano Wallet is software that helps you manage your Ada. You can use it to send and receive payments on the [Cardano blockchain](https://www.cardano.org).

This project provides an HTTP Application Programming Interface (API)
and command-line interface (CLI) for working with your wallet.
Expand All @@ -60,15 +59,9 @@ It can be used as a component of a frontend such as
interface for wallets. Most users who would like to use Cardano should
start with Daedalus.

> :information_source: This source code repository contains the next major version of Cardano
> Wallet, which has been completely rewritten for the
> [Shelley](https://roadmap.cardano.org/) phase.
>
> :bulb: The Byron version of Cardano Wallet is in the
> [cardano-sl](https://github.com/input-output-hk/cardano-sl)
> repository.
## Quickstart

## Getting Started
The `cardano-wallet` executable is an HTTP server that manages your wallet(s). Here is one way to start the server using Docker:

```
wget https://raw.githubusercontent.com/input-output-hk/cardano-wallet/master/docker-compose.yml
Expand All @@ -91,11 +84,13 @@ See also [Docker](https://cardano-foundation.github.io/cardano-wallet/user-guide

NixOS users can also use the [NixOS service](https://cardano-foundation.github.io/cardano-wallet/user-guide/NixOS).

## How to install (Linux / Windows / Mac OS)
## Obtaining `cardano-wallet`

### Executables (Linux / Windows / Mac OS)

See **Installation Instructions** for each available [release](https://github.com/input-output-hk/cardano-wallet/releases).
We provide executables as part of our [releases](https://github.com/cardano-foundation/cardano-wallet/releases). Please also see the installation instructions highlighted in the release notes.

> ### Latest releases
> **Latest releases**
>
> | cardano-wallet | cardano-node (compatible versions) |
> | --- | --- |
Expand All @@ -104,14 +99,19 @@ See **Installation Instructions** for each available [release](https://github.co
> | [v2023-04-14](https://github.com/input-output-hk/cardano-wallet/releases/tag/v2023-04-14) | [1.35.4](https://github.com/input-output-hk/cardano-node/releases/tag/1.35.4) |
> | [v2022-12-14](https://github.com/input-output-hk/cardano-wallet/releases/tag/v2022-12-14) | [1.35.4](https://github.com/input-output-hk/cardano-node/releases/tag/1.35.4) |
## How to build from sources
### Building from source

See [Building](https://cardano-foundation.github.io/cardano-wallet/developers/Building)

## How to test
### Testing

See [Testing](https://cardano-foundation.github.io/cardano-wallet/contributing/Testing)

## History

The `cardano-wallet` repository was introduced during the [Shelley phase](https://roadmap.cardano.org/) of the Cardano blockchain.
Previously, during the Byron phase, the wallet was part of the [cardano-sl](https://github.com/input-output-hk/cardano-sl) repository. (This is useful to know — sometimes the ghosts of the past come back to haunt us in the form of obscure bugs.)

## Documentation

| Link | Audience |
Expand Down

0 comments on commit a6896a2

Please sign in to comment.