diff --git a/README.md b/README.md index 6db69179a8..a0c109c367 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,17 @@ [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/hiero-ledger/solo/badge)](https://scorecard.dev/viewer/?uri=github.com/hiero-ledger/solo) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/10697/badge)](https://bestpractices.coreinfrastructure.org/projects/10697) -An opinionated CLI tool to deploy and manage standalone test networks. +A CLI tool to deploy and manage local Hiero (Hedera) test networks for +development and testing. Runs on Kubernetes — Mac, Linux, and Windows. + +## Quick Start + +```bash +npm install -g @hiero-ledger/solo@latest +solo one-shot single deploy +``` + +Full guide: [Simple Solo Setup](https://solo.hiero.org/docs/simple-solo-setup/) ## Homebrew Deprecation Notice @@ -29,6 +39,10 @@ brew uninstall solo npm install -g @hiero-ledger/solo ``` +## Documentation + +Our documentation is available here: [solo.hiero.org](https://solo.hiero.org/) + ## Releases Solo releases are supported for one month after their release date. LTS (Long-Term Support) versions are supported for three months. Upgrade to the latest version to benefit from new features and improvements. @@ -50,10 +64,6 @@ Solo releases are supported for one month after their release date. LTS (Long-Te To see a list of legacy releases, please check the [legacy versions documentation page](legacy-versions.md). -## Documentation - -Our documentation is available here: [solo.hiero.org](https://solo.hiero.org/) - ## Contributing Contributions are welcome. Please see the [contributing guide](https://github.com/hiero-ledger/.github/blob/main/CONTRIBUTING.md) to see how you can get involved. diff --git a/package.json b/package.json index 0e9de8b4a9..cceceab97a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,8 @@ { "name": "@hiero-ledger/solo", "version": "0.87.1", - "description": "An opinionated CLI tool to deploy and manage private Hedera Networks.", + "description": "Kubernetes-based local Hiero (Hedera) network for development and testing", + "homepage": "https://solo.hiero.org", "main": "./dist/src/index.js", "type": "module", "bin": {