Skip to content

Commit

Permalink
Merge pull request #2 from loftwah/dl/docs
Browse files Browse the repository at this point in the history 
improve site and docs
  • Loading branch information
@loftwah
loftwah authored Sep 2, 2024
2 parents 6012685 + a2eac88 commit f9b21cb
Show file tree
Hide file tree
Showing 2 changed files with 171 additions and 34 deletions.
23 changes: 19 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,16 @@ Grabit.sh is a powerful command-line tool designed to quickly gather and summari

### Pre-built Binaries

You can download pre-built binaries for your platform from the [Releases](https://github.com/loftwah/grabitsh/releases) page.
You can download pre-built binaries for your platform from the [Releases](https://github.com/loftwah/grabitsh/releases) page or use `curl` for direct download.

#### Linux

1. Download the `grabitsh-linux-amd64` file from the latest release.
1. Download the `grabitsh-linux-amd64` file from the latest release:

```bash
curl -L -o grabitsh-linux-amd64 https://github.com/loftwah/grabitsh/releases/latest/download/grabitsh-linux-amd64
```

2. Make it executable:

```bash
Expand All @@ -39,7 +44,11 @@ You can download pre-built binaries for your platform from the [Releases](https:

#### macOS

1. Download the `grabitsh-darwin-amd64` file from the latest release.
1. Download the `grabitsh-darwin-amd64` file from the latest release:

```bash
curl -L -o grabitsh-darwin-amd64 https://github.com/loftwah/grabitsh/releases/latest/download/grabitsh-darwin-amd64
```

2. Make it executable:

Expand All @@ -55,8 +64,14 @@ You can download pre-built binaries for your platform from the [Releases](https:

#### Windows

1. Download the `grabitsh-windows-amd64.exe` file from the latest release.
1. Download the `grabitsh-windows-amd64.exe` file from the latest release using a browser or:

```bash
curl -L -o grabitsh-windows-amd64.exe https://github.com/loftwah/grabitsh/releases/latest/download/grabitsh-windows-amd64.exe
```

2. Optionally, rename it to `grabitsh.exe` for convenience.

3. Add the directory containing the executable to your PATH environment variable.

### Building from Source
Expand Down
182 changes: 152 additions & 30 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,49 +103,114 @@
<div class="flex items-center justify-between h-16">
<div class="flex items-center">
<a href="#" class="flex-shrink-0">
<img
class="h-8 w-8"
src="public/icon.png"
alt="GRABIT.SH logo"
/>
<img class="h-8 w-8" src="public/icon.png" alt="GRABIT.SH logo" />
</a>
<div class="hidden md:block">
<div class="ml-10 flex items-baseline space-x-4">
<a
href="#features"
class="text-gray-300 hover:bg-indigo-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium"
>Features</a
>
Features
</a>
<a
href="#installation"
class="text-gray-300 hover:bg-indigo-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium"
>Installation</a
>
Installation
</a>
<a
href="#usage"
class="text-gray-300 hover:bg-indigo-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium"
>Usage</a
>
Usage
</a>
<a
href="https://github.com/loftwah/grabitsh"
class="text-gray-300 hover:bg-indigo-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium"
>GitHub</a
>
GitHub
</a>
<a
href="pages/library.html"
class="text-gray-300 hover:bg-indigo-700 hover:text-white px-3 py-2 rounded-md text-sm font-medium"
>Library</a
>
Library
</a>
</div>
</div>
</div>
<!-- Mobile menu button -->
<div class="-mr-2 flex md:hidden">
<button
type="button"
class="bg-indigo-600 inline-flex items-center justify-center p-2 rounded-md text-white hover:text-white hover:bg-indigo-700 focus:outline-none focus:ring-2 focus:ring-inset focus:ring-white"
aria-controls="mobile-menu"
aria-expanded="false"
onclick="document.getElementById('mobile-menu').classList.toggle('hidden')"
>
<span class="sr-only">Open main menu</span>
<!-- Menu open icon -->
<svg
class="block h-6 w-6"
xmlns="http://www.w3.org/2000/svg"
fill="none"
viewBox="0 0 24 24"
stroke="currentColor"
aria-hidden="true"
>
<path
stroke-linecap="round"
stroke-linejoin="round"
stroke-width="2"
d="M4 6h16M4 12h16M4 18h16"
/>
</svg>
<!-- Menu close icon -->
<svg
class="hidden h-6 w-6"
xmlns="http://www.w3.org/2000/svg"
fill="none"
viewBox="0 0 24 24"
stroke="currentColor"
aria-hidden="true"
>
<path
stroke-linecap="round"
stroke-linejoin="round"
stroke-width="2"
d="M6 18L18 6M6 6l12 12"
/>
</svg>
</button>
</div>
</div>
</nav>
<!-- Mobile Menu -->
<div class="md:hidden hidden" id="mobile-menu">
<div class="px-2 pt-2 pb-3 space-y-1 sm:px-3">
<a
href="#features"
class="text-gray-300 hover:bg-indigo-700 hover:text-white block px-3 py-2 rounded-md text-base font-medium"
>Features</a
>
<a
href="#installation"
class="text-gray-300 hover:bg-indigo-700 hover:text-white block px-3 py-2 rounded-md text-base font-medium"
>Installation</a
>
<a
href="#usage"
class="text-gray-300 hover:bg-indigo-700 hover:text-white block px-3 py-2 rounded-md text-base font-medium"
>Usage</a
>
<a
href="https://github.com/loftwah/grabitsh"
class="text-gray-300 hover:bg-indigo-700 hover:text-white block px-3 py-2 rounded-md text-base font-medium"
>GitHub</a
>
<a
href="pages/library.html"
class="text-gray-300 hover:bg-indigo-700 hover:text-white block px-3 py-2 rounded-md text-base font-medium"
>Library</a
>
</div>
</nav>
</div>
</header>

<!-- Main Content -->
Expand All @@ -166,7 +231,9 @@
<!-- Section 2: Text and Call to Actions -->
<section class="py-12 bg-white">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 text-center">
<h1 class="text-4xl font-extrabold tracking-tight text-gray-900 sm:text-5xl lg:text-6xl">
<h1
class="text-4xl font-extrabold tracking-tight text-gray-900 sm:text-5xl lg:text-6xl"
>
GRABIT.SH
</h1>
<p class="mt-4 max-w-lg mx-auto text-xl text-gray-700 sm:max-w-3xl">
Expand All @@ -180,15 +247,13 @@ <h1 class="text-4xl font-extrabold tracking-tight text-gray-900 sm:text-5xl lg:t
<a
href="#installation"
class="px-5 py-3 border border-transparent text-base font-medium rounded-md text-white bg-indigo-600 hover:bg-indigo-700"
>Get Started</a
>
Get Started
</a>
<a
href="https://github.com/loftwah/grabitsh"
class="px-5 py-3 border border-transparent text-base font-medium rounded-md text-indigo-600 bg-white hover:bg-gray-100"
>View on GitHub</a
>
View on GitHub
</a>
</div>
</div>
</section>
Expand Down Expand Up @@ -337,18 +402,65 @@ <h2 class="text-3xl font-extrabold text-gray-900 sm:text-4xl">
<div class="mt-8 bg-white overflow-hidden shadow rounded-lg">
<div class="px-4 py-5 sm:p-6">
<h3 class="text-lg leading-6 font-medium text-gray-900">
Clone and Build
Pre-built Binaries
</h3>
<div class="mt-2 max-w-xl text-sm text-gray-500">
<p>Follow these steps to install GRABIT.SH:</p>
<p>
You can download pre-built binaries for your platform from the
<a
href="https://github.com/loftwah/grabitsh/releases"
class="text-indigo-600 hover:text-indigo-900"
>Releases</a
>
page or use the following commands:
</p>
</div>
<div class="mt-3">
<!-- Installation Instructions for Linux -->
<h4 class="text-md font-bold mt-4">Linux</h4>
<pre
class="bg-gray-800 text-white p-4 rounded-md text-sm overflow-x-auto"
>
# Download the binary
curl -L -o grabitsh-linux-amd64 https://github.com/loftwah/grabitsh/releases/latest/download/grabitsh-linux-amd64

# Make it executable
chmod +x grabitsh-linux-amd64

# Move to a directory in your PATH
sudo mv grabitsh-linux-amd64 /usr/local/bin/grabitsh
</pre
>

<!-- Installation Instructions for macOS -->
<h4 class="text-md font-bold mt-4">macOS</h4>
<pre
class="bg-gray-800 text-white p-4 rounded-md text-sm overflow-x-auto"
>
# Download the binary
curl -L -o grabitsh-darwin-amd64 https://github.com/loftwah/grabitsh/releases/latest/download/grabitsh-darwin-amd64

# Make it executable
chmod +x grabitsh-darwin-amd64

# Move to a directory in your PATH
sudo mv grabitsh-darwin-amd64 /usr/local/bin/grabitsh
</pre
>

<!-- Installation Instructions for Windows -->
<h4 class="text-md font-bold mt-4">Windows</h4>
<pre
class="bg-gray-800 text-white p-4 rounded-md text-sm overflow-x-auto"
>
git clone https://github.com/loftwah/grabitsh.git
cd grabit.sh
go build -o grabitsh</pre
# Download the binary
curl -L -o grabitsh-windows-amd64.exe https://github.com/loftwah/grabitsh/releases/latest/download/grabitsh-windows-amd64.exe

# Optionally, rename it for convenience
ren grabitsh-windows-amd64.exe grabitsh.exe

# Add the directory to your PATH environment variable
</pre
>
</div>
</div>
Expand Down Expand Up @@ -377,7 +489,8 @@ <h3 class="text-lg leading-6 font-medium text-gray-900">
<pre
class="bg-gray-800 text-white p-4 rounded-md text-sm overflow-x-auto"
>
./grabitsh --output &lt;output_method&gt;</pre
./grabitsh --output &lt;output_method&gt;
</pre
>
</div>
<div class="mt-4">
Expand All @@ -401,9 +514,18 @@ <h3 class="text-lg leading-6 font-medium text-gray-900">
</div>
</section>

<!-- Embedded YouTube Video -->
<div class="flex justify-center mt-8">
<iframe width="560" height="315" src="https://www.youtube.com/embed/M6FjvHV1qak?si=SWYQ_aYUGCpu7EuD" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
<!-- Embedded YouTube Video -->
<div class="flex justify-center mt-8">
<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/M6FjvHV1qak?si=SWYQ_aYUGCpu7EuD"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
referrerpolicy="strict-origin-when-cross-origin"
allowfullscreen
></iframe>
</div>
<!-- End of Embedded Video -->

Expand Down

0 comments on commit f9b21cb

Please sign in to comment.