From 0131682b1f3183ad2af2195b0d723bfc8537bab7 Mon Sep 17 00:00:00 2001 From: Roei Erez Date: Sun, 7 May 2023 18:51:18 +0300 Subject: [PATCH] fix typos --- src/SUMMARY.md | 2 +- src/guide/Installing.md | 1 + src/guide/getting_started.md | 4 ++-- src/guide/install.md | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) create mode 100644 src/guide/Installing.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index bb931d6..70c5fd0 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -2,7 +2,7 @@ # API Overview -- [Install](guide/install.md) +- [Installing](guide/install.md) - [Getting Started](guide/getting_started.md) - [Lightning payments](guide/payments.md) - [Receiving an on-chain transaction](guide/recieve_onchain.md) diff --git a/src/guide/Installing.md b/src/guide/Installing.md new file mode 100644 index 0000000..55af1c5 --- /dev/null +++ b/src/guide/Installing.md @@ -0,0 +1 @@ +# Install diff --git a/src/guide/getting_started.md b/src/guide/getting_started.md index 4cb8118..a39f783 100644 --- a/src/guide/getting_started.md +++ b/src/guide/getting_started.md @@ -11,9 +11,9 @@ The Breez SDK provides the following services: Connecting to a node requires a seed (your master key) and credentials. The seed is a bip39 mnemonic and the credentials are retrieved by registering a new node or recovering an existing one. -## Installation +## Installing -Breez SDK is available in several platforms. Follow the [install](install.md) page to install on your platform. +Breez SDK is available in several platforms. Follow the [Installing](install.md) page for instructions on how to install on your platform. ## Registering a new node ```rust,no_run diff --git a/src/guide/install.md b/src/guide/install.md index 491d09b..ec1f936 100644 --- a/src/guide/install.md +++ b/src/guide/install.md @@ -1,4 +1,4 @@ -# Install +# Installing The Breez SDK is available in the following platforms: