Skip to content

Commit

Permalink
Rename to stellar-cli
Browse files Browse the repository at this point in the history
  • Loading branch information
Jane Wang authored and Jane Wang committed May 30, 2024
1 parent 8c17d74 commit a05cc1c
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 26 deletions.
26 changes: 13 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to soroban-cli
# Contributing to stellar-cli

Thanks for taking the time to improve soroban-cli!
Thanks for taking the time to improve stellar-cli!

The following is a set of guidelines for contributions and may change over time.
Feel free to suggest improvements to this document in a pull request.We want to make it as easy as possible to contribute changes that help the Stellar network grow and
Expand Down Expand Up @@ -38,29 +38,29 @@ Of course, feel free to create a new issue if you think something needs to be ad

## Making Changes

* Fork the soroban-cli repo to your own Github account
* Fork the stellar-cli repo to your own Github account

* List the current configured remote repository for your fork. Your git remote
should initially look like this.
```
$ git remote -v
> origin https://github.com/YOUR_USERNAME/soroban-cli.git (fetch)
> origin https://github.com/YOUR_USERNAME/soroban-cli.git (push)
> origin https://github.com/YOUR_USERNAME/stellar-cli.git (fetch)
> origin https://github.com/YOUR_USERNAME/stellar-cli.git (push)
```

* Set the `stellar/soroban-cli` repo as new remote upstream repository that will
* Set the `stellar/stellar-cli` repo as new remote upstream repository that will
sync with your fork.
```
git remote add upstream https://github.com/stellar/soroban-cli.git
git remote add upstream https://github.com/stellar/stellar-cli.git
```

* Verify the new upstream repository you've specified for your fork.
```
$ git remote -v
> origin https://github.com/YOUR_USERNAME/soroban-cli.git (fetch)
> origin https://github.com/YOUR_USERNAME/soroban-cli.git (push)
> upstream https://github.com/stellar/soroban-cli.git (fetch)
> upstream https://github.com/stellar/soroban-cli.git (push)
> origin https://github.com/YOUR_USERNAME/stellar-cli.git (fetch)
> origin https://github.com/YOUR_USERNAME/stellar-cli.git (push)
> upstream https://github.com/stellar/stellar-cli.git (fetch)
> upstream https://github.com/stellar/stellar-cli.git (push)
```

* Add git hooks for commits and pushes so that checks run before pushing:
Expand All @@ -69,7 +69,7 @@ sync with your fork.
```

* Create a topic branch for your changes in your local repo. When you push you should be able
to create PR based on upstream stellar/soroban-cli.
to create PR based on upstream stellar/stellar-cli.

* Make sure you have added the necessary tests for your changes and make sure all tests pass.

Expand All @@ -95,6 +95,6 @@ alternatives.

This document is inspired by:

[help-wanted]: https://github.com/stellar/soroban-cli/contribute
[help-wanted]: https://github.com/stellar/stellar-cli/contribute
[commit-msg]: https://github.com/erlang/otp/wiki/Writing-good-commit-messages
[coc]: https://github.com/stellar/.github/blob/master/CODE_OF_CONDUCT.md
23 changes: 10 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Soroban CLI (soroban-cli)
# Stellar CLI (stellar-cli)

This repo is home to the Soroban CLI, the command-line multi-tool for running and deploying Soroban contracts on the Stellar network.
This repo is home to the Stellar CLI, the command-line multi-tool for running and deploying Stellar contracts on the Stellar network.

## Documentation

Expand All @@ -9,47 +9,44 @@ For installation options see below, for usage instructions [see the full help do
## Install
Install the latest version from source:
```
cargo install --locked soroban-cli --features opt
cargo install --locked stellar-cli --features opt
```

Install with `cargo-binstall`:
```
cargo install --locked cargo-binstall
cargo binstall -y soroban-cli
cargo binstall -y stellar-cli
```

Install with Homebrew:

```
brew install stellar/tap/soroban-cli
brew install stellar/tap/stellar-cli
```

## Setup Autocomplete
```
soroban completion --shell <SHELL>
stellar completion --shell <SHELL>
```
Possible SHELL values are `bash`, `elvish`, `fish`, `powershell`, `zsh`, etc.

To enable autocomplete in the current bash shell, run:
```
source <(soroban completion --shell bash)
source <(stellar completion --shell bash)
```

To enable autocomplete permanently, run:
```
echo "source <(soroban completion --shell bash)" >> ~/.bashrc
echo "source <(stellar completion --shell bash)" >> ~/.bashrc
```

## Latest Release
For latest releases, see [releases](https://github.com/stellar/soroban-cli/releases).
For latest releases, 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).

## To Contribute
Find issues to contribute to [here](https://github.com/stellar/soroban-cli/contribute) and review [CONTRIBUTING.md](/CONTRIBUTING.md).
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



0 comments on commit a05cc1c

Please sign in to comment.