Skip to content

Commit e88fea2

Browse files
kristiankarlCopilot
authored andcommitted
docs: add crates.io installation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent b1890c3 commit e88fea2

2 files changed

Lines changed: 5 additions & 10 deletions

File tree

‎src/components/QuickStart.astro‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,14 @@ const steps = [
77
{
88
n: '01',
99
title: 'Install',
10-
desc: 'Build the binary with Cargo, or grab a prebuilt release.',
10+
desc: 'Install the GraphWalker CLI directly from crates.io.',
1111
code: {
12-
title: 'bash — build from source',
12+
title: 'bash — install from crates.io',
1313
lang: 'bash',
1414
lines: [
15-
['git clone https://github.com/GraphWalker/graphwalker-rs.git', null],
16-
['cd graphwalker-rs', null],
17-
['cargo build --release', null],
18-
['export PATH="$PWD/target/release:$PATH"', null],
15+
['cargo install graphwalker', null],
1916
],
20-
note: `Alternative: prebuilt binaries on ${LINKS.githubReleases.replace(
21-
'https://github.com/',
22-
'',
23-
)}.`,
17+
note: `Requires Rust and Cargo. View the package on ${LINKS.crates.replace('https://', '')}. Build from source or download prebuilt binaries from ${LINKS.githubReleases.replace('https://github.com/', '')}.`,
2418
},
2519
},
2620
{

‎src/constants.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ export const SITE = {
1010
export const LINKS = {
1111
github: 'https://github.com/GraphWalker/graphwalker-rs',
1212
githubReleases: 'https://github.com/GraphWalker/graphwalker-rs/releases',
13+
crates: 'https://crates.io/crates/graphwalker',
1314
org: 'https://github.com/GraphWalker',
1415
siteSource: 'https://github.com/GraphWalker/graphwalker.github.io',
1516
legacyJava: 'https://github.com/GraphWalker/graphwalker-project',

0 commit comments

Comments
 (0)