From e237f6fb50df0448a2407b1003faee0d39f4a005 Mon Sep 17 00:00:00 2001 From: Jane Wang Date: Tue, 9 Jul 2024 11:11:48 -0400 Subject: [PATCH 1/3] Add additional content to README --- README.md | 35 +++++++++++++++++++++++++++-------- 1 file changed, 27 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 120c9d3b9..4f074a94b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,28 @@ # Stellar CLI (stellar-cli) +[![Apache 2.0 licensed](https://img.shields.io/badge/license-apache%202.0-blue.svg)] + This repo is home to the Stellar CLI, the command-line multi-tool for running and deploying Stellar contracts on the Stellar network. + +## Table of Contents + +- [Documentation](#documentation) +- [Installation](#installation) +- [Installation with Experimental Features](#installation-with-experiemental-featuers) +- [Autocomplete](#autocomplete) +- [Latest Release](#latest-release) +- [Upcoming Features](#upcoming-features) +- [To Contribute](#to-contribute) +- [Additional Developer Resources](#additional-developer-resources) + + + ## Documentation For installation options see below, for usage instructions [see the full help docs](FULL_HELP_DOCS.md). -## Install +## Installation Install the latest version from source: ``` cargo install --locked stellar-cli --features opt @@ -24,13 +40,16 @@ Install with Homebrew: brew install stellar/tap/stellar-cli ``` -## Install Experimental Features +## Installation with Experimental Features To use the potentially unreleased bleeding edge CLI functionalities, install from git: ``` -cargo install --locked stellar-cli --features opt --git git@github.com:stellar/stellar-cli.git +cargo install --locked stellar-cli --features opt --git https://github.com/stellar/stellar-cli.git ``` -## Setup Autocomplete +## Autocomplete +The Stellar CLI supports some basic autocompletion. To set up autocomplete, run +the following commands: + ``` stellar completion --shell ``` @@ -47,7 +66,7 @@ echo "source <(stellar completion --shell bash)" >> ~/.bashrc ``` ## Latest Release -For latest releases, see [releases](https://github.com/stellar/stellar-cli/releases). +For the latest release, see [releases](https://github.com/stellar/stellar-cli/releases). ## Upcoming Features For upcoming features, please see the [project board](https://github.com/orgs/stellar/projects/50). @@ -55,6 +74,6 @@ For upcoming features, please see the [project board](https://github.com/orgs/st ## To Contribute Find issues to contribute to [here](https://github.com/stellar/stellar-cli/contribute) and review [CONTRIBUTING.md](/CONTRIBUTING.md). -Developer Docs: https://developers.stellar.org/docs - -Developer Docs CLI Examples: https://developers.stellar.org/docs/smart-contracts/guides/cli +## Additional Developer Resources +- Developer Docs CLI Examples: https://developers.stellar.org/docs/smart-contracts/guides/cli +- Video Tutorial: https://developers.stellar.org/meetings/2024/06/27 From 99eeb5265c30d80513d00d752bbef4d6069842df Mon Sep 17 00:00:00 2001 From: Jane Wang Date: Tue, 9 Jul 2024 11:14:02 -0400 Subject: [PATCH 2/3] Fix spelling --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4f074a94b..21f5fa961 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ This repo is home to the Stellar CLI, the command-line multi-tool for running an - [Documentation](#documentation) - [Installation](#installation) -- [Installation with Experimental Features](#installation-with-experiemental-featuers) +- [Installation with Experimental Features](#installation-with-experiemental-features) - [Autocomplete](#autocomplete) - [Latest Release](#latest-release) - [Upcoming Features](#upcoming-features) From e3b9d71cabd8b58da9bc69b0a6fee06ca16d3184 Mon Sep 17 00:00:00 2001 From: Jane Wang Date: Tue, 9 Jul 2024 14:12:09 -0400 Subject: [PATCH 3/3] Fix nit --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 21f5fa961..9f0a365e5 100644 --- a/README.md +++ b/README.md @@ -47,8 +47,7 @@ cargo install --locked stellar-cli --features opt --git https://github.com/stell ``` ## Autocomplete -The Stellar CLI supports some basic autocompletion. To set up autocomplete, run -the following commands: +The Stellar CLI supports some autocompletion. To set up, run the following commands: ``` stellar completion --shell