Skip to content

Commit dc70aea

Browse files
authored
Improved README.md
1 parent e5fbbd2 commit dc70aea

File tree

1 file changed

+66
-2
lines changed

1 file changed

+66
-2
lines changed

README.md

Lines changed: 66 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,66 @@
1-
# moderne-cli-releases
2-
Public releases of `mod`, the Moderne CLI.
1+
# Moderne CLI releases
2+
3+
The Moderne CLI is a tool that allows you to build and publish [Lossless Semantic Tree](https://docs.moderne.io/concepts/lossless-semantic-trees) (LST) artifacts to an artifact repository of your choosing.
4+
5+
## Installation
6+
7+
### Homebrew (macOS/Linux)
8+
9+
```bash
10+
# Stable releases
11+
brew install moderneinc/moderne/mod
12+
13+
# Beta releases (latest pre-release)
14+
brew install moderneinc/moderne/mod --head
15+
```
16+
17+
### Chocolatey (Windows)
18+
19+
```powershell
20+
# Stable releases
21+
choco install mod
22+
23+
# Beta releases
24+
choco install mod-beta
25+
```
26+
27+
### Direct download
28+
29+
Download the latest release for your platform:
30+
31+
- **Linux**: [moderne-cli-linux](https://github.com/moderneinc/moderne-cli-releases/releases/latest/download/moderne-cli-linux)
32+
- **macOS**: [moderne-cli-macos](https://github.com/moderneinc/moderne-cli-releases/releases/latest/download/moderne-cli-macos)
33+
- **Windows**: [moderne-cli-windows.exe](https://github.com/moderneinc/moderne-cli-releases/releases/latest/download/moderne-cli-windows.exe)
34+
35+
Archive formats are also available:
36+
- [moderne-cli-linux.tar.gz](https://github.com/moderneinc/moderne-cli-releases/releases/latest/download/moderne-cli-linux.tar.gz)
37+
- [moderne-cli-macos.tar.gz](https://github.com/moderneinc/moderne-cli-releases/releases/latest/download/moderne-cli-macos.tar.gz)
38+
39+
## Release process
40+
41+
### Pre-releases
42+
43+
Pre-releases are available through:
44+
- Homebrew head formula (`mod --head`)
45+
- Chocolatey beta package (`mod-beta`)
46+
- Direct download from the releases page
47+
48+
### Stable releases
49+
50+
Stable releases are promoted from pre-releases and become the default installation for package managers and the `/releases/latest/` download URLs.
51+
52+
## Getting started
53+
54+
After installation, verify the CLI is working:
55+
56+
```bash
57+
mod --version
58+
```
59+
60+
For usage instructions and documentation, visit the [Moderne CLI documentation](https://docs.moderne.io/user-documentation/moderne-cli).
61+
62+
## Support
63+
64+
For issues and questions:
65+
- [Documentation](https://docs.moderne.io/user-documentation/moderne-cli)
66+
- Email: support@moderne.io

0 commit comments

Comments
 (0)