Skip to content

Commit fd31799

Browse files
committed
doc: update readme and site formatting
1 parent 46f1138 commit fd31799

File tree

2 files changed

+57
-9
lines changed

2 files changed

+57
-9
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
### Install Script (macOS/Linux/Windows)
2121

2222
```bash
23-
curl -fsSL https://github.com/trollefson/shipit/releases/latest/download/install.sh | bash
23+
curl -fsSL gitshipit.net/install | bash
2424
```
2525

2626
### Cargo
@@ -114,8 +114,7 @@ shipit b2b develop main --dir /path/to/repo
114114
Writes or overwrites a default config file to the platform config directory and prints the path.
115115

116116
Default config location:
117-
- **Linux:** `~/.config/shipit/default-config.toml`
118-
- **macOS:** `~/Library/Application Support/shipit/default-config.toml`
117+
- **Linux & macOS:** `~/.config/shipit/default-config.toml`
119118
- **Windows:** `%APPDATA%\shipit\default-config.toml`
120119

121120
```bash
@@ -155,4 +154,4 @@ If shipit saves you time, a coffee goes a long way.
155154

156155
## License
157156

158-
[MIT](LICENSE)
157+
[MIT](LICENSE)

site/index.html

Lines changed: 54 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,40 @@
159159
}
160160
.bmc-button:hover { transform: scale(1.03); }
161161
.bmc-button img { width: 25px; margin-right: 10px; }
162+
163+
/* Source Links Section */
164+
.source-links {
165+
margin-top: 20px;
166+
display: flex;
167+
justify-content: center;
168+
gap: 12px;
169+
flex-wrap: wrap;
170+
}
171+
.source-btn {
172+
display: inline-flex;
173+
align-items: center;
174+
gap: 8px;
175+
background-color: var(--surface2);
176+
color: var(--text);
177+
padding: 10px 18px;
178+
border-radius: 8px;
179+
text-decoration: none;
180+
font-weight: 600;
181+
font-size: 0.9rem;
182+
border: 1px solid var(--border);
183+
transition: all 0.2s ease;
184+
}
185+
.source-btn:hover {
186+
border-color: var(--primary);
187+
color: var(--primary);
188+
box-shadow: 0 0 12px rgba(0, 200, 255, 0.15);
189+
}
190+
.source-btn svg {
191+
width: 20px;
192+
height: 20px;
193+
fill: currentColor;
194+
flex-shrink: 0;
195+
}
162196
</style>
163197
</head>
164198
<body>
@@ -181,7 +215,7 @@ <h3 id="os-label">Detecting your system...</h3>
181215

182216
<div class="other-links">
183217
<p>Looking for a different version?</p>
184-
<a href="https://github.com/trollefson/shipit/releases/latest">All releases on GitHub</a>
218+
<a href="https://github.com/trollefson/shipit/releases">All releases on GitHub</a>
185219
</div>
186220

187221
<div class="coffee-section">
@@ -191,10 +225,25 @@ <h3 id="os-label">Detecting your system...</h3>
191225
<span>Buy me a coffee</span>
192226
</a>
193227
</div>
228+
229+
<div class="source-links">
230+
<a class="source-btn" href="https://github.com/trollefson/shipit" target="_blank" rel="noopener">
231+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" aria-hidden="true">
232+
<path d="M12 0C5.374 0 0 5.373 0 12c0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23A11.509 11.509 0 0 1 12 5.803c1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576C20.566 21.797 24 17.3 24 12c0-6.627-5.373-12-12-12z"/>
233+
</svg>
234+
GitHub
235+
</a>
236+
<a class="source-btn" href="https://crates.io/crates/shipit" target="_blank" rel="noopener">
237+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" aria-hidden="true">
238+
<path d="M239.108 10.689 32.341 128.347a32 32 0 0 0-16 27.713v200.627a32 32 0 0 0 16.136 27.77L239.244 501.44a32 32 0 0 0 31.728.072l208-116.5a32 32 0 0 0 16.328-27.84V156.06a32 32 0 0 0-15.872-27.641L271.108 10.76a32 32 0 0 0-32 .072zm106.154 134.809L256 197.621l-89.262-52.123L256 93.375zm-202.95 36.37L234.5 232.5v112.127L142.312 292zm226.476 112.254V232.5l92.188-51.632v112.127z"/>
239+
</svg>
240+
crates.io
241+
</a>
242+
</div>
194243
</div>
195244

196245
<script>
197-
const INSTALL_SH = "curl -fsSL https://github.com/trollefson/shipit/releases/latest/download/install.sh | bash";
246+
const INSTALL_SH = "curl -fsSL gitshipit.net/install | bash";
198247
const BREW_CMD = "brew tap trollefson/shipit && brew install shipit";
199248

200249
function detectOS() {
@@ -210,11 +259,11 @@ <h3 id="os-label">Detecting your system...</h3>
210259
if (isMac) {
211260
label.innerText = "Install on macOS";
212261
desc.innerText = "Install shipit via Homebrew:";
213-
cmdLabel.innerText = "Homebrew";
214-
cmdEl.innerText = BREW_CMD;
262+
cmdLabel.innerText = "Shell";
263+
cmdEl.innerText = INSTALL_SH;
215264
} else if (platform.includes('win') || ua.includes('Windows')) {
216265
label.innerText = "Install on Windows";
217-
desc.innerText = "Run this command in PowerShell or WSL:";
266+
desc.innerText = "Run this command in WSL:";
218267
cmdLabel.innerText = "Shell";
219268
cmdEl.innerText = INSTALL_SH;
220269
} else {

0 commit comments

Comments
 (0)