Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
206 changes: 49 additions & 157 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@

<title>bump - Semantic Versioning for Git</title>

<!-- Variable Fonts: Recursive and Rec Mono -->
<!-- Variable Fonts: Recursive and Rec Mono Duotone -->
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Recursive:wght,CASL,MONO@300..1000,0..1,0..1&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Recursive:wght,CASL,MONO@300..1000,0..1,0..1&family=Rec+Mono+Duotone:wght@300..1000&display=swap" rel="stylesheet">

<link rel="stylesheet" href="styles.css" />
</head>
Expand Down Expand Up @@ -55,73 +55,37 @@ <h1 class="hero-title">bump</h1>

<section id="demo" class="demo-section">
<div class="container">
<div class="terminal">
<div class="terminal-header">
<div class="terminal-controls">
<span class="control close"></span>
<span class="control minimize"></span>
<span class="control maximize"></span>
</div>
<div class="terminal-title">terminal — bump</div>
</div>
<div class="terminal-body">
<div class="terminal-line">
<span class="prompt">$</span> <span class="command">bump</span>
</div>
<div class="terminal-line output">
<span class="bullet success">●</span> on default branch: <span class="value">main</span>
</div>
<div class="terminal-line output">
<span class="bullet success">●</span> no uncommitted changes
</div>
<div class="terminal-line output">
<span class="bullet success">●</span> no remote changes
</div>
<div class="terminal-line output">
<span class="bullet success">●</span> no unpushed changes
</div>
<div class="terminal-line output">
<span class="bullet success">●</span> no new remote tags
</div>
<div class="terminal-line output">
<span class="bullet info">●</span> bump tag <span class="version old">v1.2.3</span> <span class="arrow">→</span> <span class="version new">v1.2.4</span>
</div>
<div class="terminal-line output">
<span class="bullet success">●</span> tag <span class="version new">v1.2.4</span> created
</div>
<div class="terminal-line output">
<span class="bullet success">●</span> tag <span class="version new">v1.2.4</span> pushed
</div>
</div>
</div>
<pre class="terminal-output"><code>$ bump
● on default branch: main
● no uncommitted changes
● no remote changes
● no unpushed changes
● no new remote tags
● bump tag v1.2.3 → v1.2.4
● tag v1.2.4 created
● tag v1.2.4 pushed</code></pre>
</div>
</section>

<section id="install" class="section">
<div class="container">
<h2 class="section-title">Installation</h2>

<div class="install-grid">
<div class="install-list">
<div class="install-method">
<h3 class="method-title">Homebrew</h3>
<div class="code-block">
<code>brew tap flaticols/apps
brew install flaticols/apps/bump</code>
</div>
<pre class="code-block"><code>brew tap flaticols/apps
brew install flaticols/apps/bump</code></pre>
</div>

<div class="install-method">
<h3 class="method-title">Go</h3>
<div class="code-block">
<code>go install github.com/flaticols/bump@latest</code>
</div>
<pre class="code-block"><code>go install github.com/flaticols/bump@latest</code></pre>
</div>

<div class="install-method">
<h3 class="method-title">Binary</h3>
<a href="https://github.com/flaticols/bump/releases" class="button" target="_blank" rel="noopener">
Download Latest Release
</a>
<p><a href="https://github.com/flaticols/bump/releases" target="_blank" rel="noopener">Download latest release from GitHub</a></p>
</div>
</div>
</div>
Expand All @@ -133,43 +97,33 @@ <h2 class="section-title">Usage</h2>

<p class="section-intro">Bump follows semantic versioning principles, allowing you to easily increment major, minor, or patch versions.</p>

<div class="usage-grid">
<div class="usage-card">
<div class="usage-command">
<code>bump</code>
</div>
<div class="usage-list">
<div class="usage-item">
<code class="usage-command">bump</code>
<p class="usage-description">Bumps patch version</p>
<p class="usage-example">1.2.3 → 1.2.4</p>
</div>

<div class="usage-card">
<div class="usage-command">
<code>bump major</code>
</div>
<div class="usage-item">
<code class="usage-command">bump major</code>
<p class="usage-description">Bumps major version</p>
<p class="usage-example">1.2.3 → 2.0.0</p>
</div>

<div class="usage-card">
<div class="usage-command">
<code>bump minor</code>
</div>
<div class="usage-item">
<code class="usage-command">bump minor</code>
<p class="usage-description">Bumps minor version</p>
<p class="usage-example">1.2.3 → 1.3.0</p>
</div>

<div class="usage-card">
<div class="usage-command">
<code>bump patch</code>
</div>
<div class="usage-item">
<code class="usage-command">bump patch</code>
<p class="usage-description">Bumps patch version</p>
<p class="usage-example">1.2.3 → 1.2.4</p>
</div>

<div class="usage-card">
<div class="usage-command">
<code>bump undo</code>
</div>
<div class="usage-item">
<code class="usage-command">bump undo</code>
<p class="usage-description">Removes the last version tag</p>
<p class="usage-example">v1.2.4 → v1.2.3</p>
</div>
Expand Down Expand Up @@ -211,97 +165,43 @@ <h3 class="subsection-title">Options</h3>
<div class="container">
<h2 class="section-title">Features</h2>

<div class="features-grid">
<div class="feature-card">
<div class="feature-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
<path d="M20 7h-3a2 2 0 0 1-2-2V2M9 18a3 3 0 1 0-6 0c0 1.657 3 3 3 3s3-1.343 3-3M15 11a3 3 0 1 0-6 0c0 1.657 3 3 3 3s3-1.343 3-3"/>
<path d="M14 2v3a2 2 0 0 0 2 2h3l-5-5zM3 12h3M3 17h3"/>
</svg>
</div>
<div class="features-list">
<div class="feature-item">
<h3 class="feature-title">Auto-Detection</h3>
<p class="feature-description">Automatically detects and increments from the latest git tag</p>
</div>

<div class="feature-card">
<div class="feature-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
<circle cx="12" cy="12" r="3"/>
<path d="M3 7v10a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2V7"/>
<path d="M6 7V5a2 2 0 0 1 2-2h8a2 2 0 0 1 2 2v2"/>
</svg>
</div>
<div class="feature-item">
<h3 class="feature-title">Branch Validation</h3>
<p class="feature-description">Validates you're on a default branch (main, master, etc.)</p>
</div>

<div class="feature-card">
<div class="feature-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
<circle cx="12" cy="12" r="10"/>
<polyline points="12 6 12 12 16 14"/>
</svg>
</div>
<div class="feature-item">
<h3 class="feature-title">Change Detection</h3>
<p class="feature-description">Checks for uncommitted changes and remote synchronization</p>
</div>

<div class="feature-card">
<div class="feature-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
<path d="M21 15v4a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-4"/>
<polyline points="17 8 12 3 7 8"/>
<line x1="12" y1="3" x2="12" y2="15"/>
</svg>
</div>
<div class="feature-item">
<h3 class="feature-title">Automatic Pushing</h3>
<p class="feature-description">Creates and pushes git tags using semantic versioning</p>
</div>

<div class="feature-card">
<div class="feature-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
<path d="M3 7v13a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2V7"/>
<path d="M8 7V5a2 2 0 0 1 2-2h4a2 2 0 0 1 2 2v2"/>
<path d="M12 12v5"/>
</svg>
</div>
<div class="feature-item">
<h3 class="feature-title">Version Rollback</h3>
<p class="feature-description">Easily remove the most recent version tag when needed</p>
</div>

<div class="feature-card">
<div class="feature-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
<polyline points="16 18 22 12 16 6"/>
<polyline points="8 6 2 12 8 18"/>
</svg>
</div>
<div class="feature-item">
<h3 class="feature-title">Colorful Output</h3>
<p class="feature-description">Visually appealing terminal feedback with status indicators</p>
</div>

<div class="feature-card">
<div class="feature-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
<path d="M21 16V8a2 2 0 0 0-1-1.73l-7-4a2 2 0 0 0-2 0l-7 4A2 2 0 0 0 3 8v8a2 2 0 0 0 1 1.73l7 4a2 2 0 0 0 2 0l7-4A2 2 0 0 0 21 16z"/>
<polyline points="7.5 4.21 12 6.81 16.5 4.21"/>
<polyline points="7.5 19.79 7.5 14.6 3 12"/>
<polyline points="21 12 16.5 14.6 16.5 19.79"/>
<polyline points="3.27 6.96 12 12.01 20.73 6.96"/>
<line x1="12" y1="22.08" x2="12" y2="12"/>
</svg>
</div>
<div class="feature-item">
<h3 class="feature-title">Tag Sync</h3>
<p class="feature-description">Automatically detects and fetches new tags from remote</p>
</div>

<div class="feature-card">
<div class="feature-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
<path d="M12 22s8-4 8-10V5l-8-3-8 3v7c0 6 8 10 8 10z"/>
</svg>
</div>
<div class="feature-item">
<h3 class="feature-title">Brave Mode</h3>
<p class="feature-description">Bypass warnings and continue operations for advanced users</p>
</div>
Expand All @@ -313,44 +213,39 @@ <h3 class="feature-title">Brave Mode</h3>
<div class="container">
<h2 class="section-title">Examples</h2>

<div class="examples-grid">
<div class="example-card">
<div class="examples-list">
<div class="example-item">
<h3 class="example-title">Standard Version Bumping</h3>
<p class="example-description">Increment the patch version number</p>
<div class="code-block">
<code>$ bump
<pre class="code-block"><code>$ bump
● on default branch: main
● no uncommitted changes
● no remote changes
● no unpushed changes
● no new remote tags
● bump tag v1.2.3 → v1.2.4
● tag v1.2.4 created
● tag v1.2.4 pushed</code>
</div>
● tag v1.2.4 pushed</code></pre>
</div>

<div class="example-card">
<div class="example-item">
<h3 class="example-title">Major Version for Breaking Changes</h3>
<p class="example-description">Increment the major version for breaking changes</p>
<div class="code-block">
<code>$ bump major
<pre class="code-block"><code>$ bump major
● on default branch: main
● no uncommitted changes
● no remote changes
● no unpushed changes
● no new remote tags
● bump tag v1.2.3 → v2.0.0
● tag v2.0.0 created
● tag v2.0.0 pushed</code>
</div>
● tag v2.0.0 pushed</code></pre>
</div>

<div class="example-card">
<div class="example-item">
<h3 class="example-title">Using a Different Repository</h3>
<p class="example-description">Specify a different repository path</p>
<div class="code-block">
<code>$ bump --repo=/path/to/repo minor
<pre class="code-block"><code>$ bump --repo=/path/to/repo minor
● working directory: /path/to/repo
● on default branch: main
● no uncommitted changes
Expand All @@ -359,20 +254,17 @@ <h3 class="example-title">Using a Different Repository</h3>
● no new remote tags
● bump tag v1.2.3 → v1.3.0
● tag v1.3.0 created
● tag v1.3.0 pushed</code>
</div>
● tag v1.3.0 pushed</code></pre>
</div>

<div class="example-card">
<div class="example-item">
<h3 class="example-title">Using Brave Mode</h3>
<p class="example-description">Skip all confirmation prompts with brave mode</p>
<div class="code-block">
<code>$ bump undo --brave
<pre class="code-block"><code>$ bump undo --brave
● brave mode enabled
● removing tag v1.2.4
● local tag removed
● remote tag removed</code>
</div>
● remote tag removed</code></pre>
</div>
</div>
</div>
Expand Down
Loading