From a6896a21b530843515a2e720cce5a8cba1d89d4a Mon Sep 17 00:00:00 2001 From: Heinrich Apfelmus Date: Tue, 11 Jul 2023 17:05:31 +0200 Subject: [PATCH 1/2] doc: Clarify readme --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 4034a34b7ff..eab1270cdc0 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 @@ -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) | > | --- | --- | @@ -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 | From 7284dace1401a95b448e85ce2d836f0fc5523d64 Mon Sep 17 00:00:00 2001 From: Heinrich Apfelmus Date: Thu, 13 Jul 2023 12:46:22 +0200 Subject: [PATCH 2/2] doc: Fix links in readme --- README.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index eab1270cdc0..6bc18364935 100644 --- a/README.md +++ b/README.md @@ -8,18 +8,18 @@

- + - + - + @@ -41,9 +41,7 @@

-

- E2E Tests Status -

+
@@ -64,7 +62,7 @@ start with Daedalus. 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 +wget https://raw.githubusercontent.com/cardano-foundation/cardano-wallet/master/docker-compose.yml NETWORK=mainnet docker-compose up ``` @@ -95,9 +93,9 @@ We provide executables as part of our [releases](https://github.com/cardano-foun > | cardano-wallet | cardano-node (compatible versions) | > | --- | --- | > | `master` branch | [8.1.1](https://github.com/input-output-hk/cardano-node/releases/tag/8.1.1) | -> | [v2023-07-18](https://github.com/input-output-hk/cardano-wallet/releases/tag/v2023-07-18) | [8.1.1](https://github.com/input-output-hk/cardano-node/releases/tag/8.1.1) | -> | [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) | +> | [v2023-07-18](https://github.com/cardano-foundation/cardano-wallet/releases/tag/v2023-07-18) | [8.1.1](https://github.com/input-output-hk/cardano-node/releases/tag/8.1.1) | +> | [v2023-04-14](https://github.com/cardano-foundation/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/cardano-foundation/cardano-wallet/releases/tag/v2022-12-14) | [1.35.4](https://github.com/input-output-hk/cardano-node/releases/tag/1.35.4) | ### Building from source @@ -125,5 +123,5 @@ Previously, during the Byron phase, the wallet was part of the [cardano-sl](http

- +