Skip to content

docs: improve README and npm discoverability for AI assistants #5885

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Reccetech wants to merge 1 commit into from
+17 −6
Closed

docs: improve README and npm discoverability for AI assistants #5885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand All @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
Loading