Skip to content

Commit

Permalink
docs: Update website
Browse files Browse the repository at this point in the history
  • Loading branch information
Strappazzon committed Feb 27, 2021
1 parent d247f6a commit 89b03ff
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 49 deletions.
11 changes: 0 additions & 11 deletions docs/README.md

This file was deleted.

51 changes: 13 additions & 38 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
---
layout: default
title: "SuperBLT Hasher | VB.Net implementation of SuperBLT Hashing Library"
description: "Visual Basic .Net implementation of the SuperBLT Hashing Library. Hashing of single files and folders is supported."
title: "SuperBLT Hasher"
description: "Generate hashes for PAYDAY 2 mods. Hashing of single files and folders is supported."
---

<h1 align="center">
<br>
<img src="https://strappazzon.github.io/PD2-SuperBLT-Hasher/static/img/favicon.png" width="128px" alt="">
<img src="static/img/favicon.png" width="128px" alt="">
<br>
SuperBLT Hasher
<br>
</h1>

<h4 align="center">VB.Net implementation of SuperBLT Hashing Library.</h4>
<h4 align="center">Generate hashes for PAYDAY 2 mods.</h4>

<p align="center">
<a href="#about">About</a> •
<a href="#usage">Usage</a> •
<a href="#settings">Settings</a> •
<a href="#screenshot">Screenshot</a> •
<a href="#download">Download</a> •
<a href="#source-code">Source Code</a> •
Expand All @@ -26,52 +25,28 @@ description: "Visual Basic .Net implementation of the SuperBLT Hashing Library.

## About

SuperBLT Hasher is a Visual Basic .Net implementation of the [SuperBLT Hashing Library](https://gitlab.com/SuperBLT/HashLib). Hashing of single files and folders is supported.
SuperBLT Hasher is a Visual Basic .Net/C# implementation of the [SuperBLT Hashing Library](https://gitlab.com/SuperBLT/HashLib). Hashing of single files and folders is supported.

## Usage

### GUI

1. Launch **SuperBLTHasher.exe**.
2. Customize the settings by ticking\unticking the checkboxes.
3. Drag and drop a folder or file inside the dark area where it says **"Drag a folder or file here"**.
1. Launch **SuperBLT Hasher.exe**.
2. Drag and drop a folder or file inside the dark area where it says **"Drag a folder or file here"**.
3. Copy the hash to clipboard.

### Command Line

SuperBLT Hasher accepts the following command line arguments:

| Name | Long Name | Required? | Description |
|------|---------------|-----------|--------------------------------------------------------------------------------------------------------------|
| `-p` | `--path` | Yes | Path to folder or file you want to hash. <br> If the path contains spaces, quotation marks are **required**. |
| `-e` | `--export` | No | If you include this argument, the program will ask you where you want to save the computed hash. |
| `-c` | `--clipboard` | No | If you include this argument, the program will copy the computed hash to the clipboard. |
Simply pass the file or folder path to **superblthasher-cli.exe**.

#### Example

> SuperBLTHasher -p <span class="h-s">"D:\Path\To My Mod\Folder"</span> -c
This command would compute the hash of the folder `D:\Path\To My Mod\Folder` and copy the computed hash to the clipboard.

## Settings

* **Write hash to file**
* _Disabled by default_
* The program will ask you where you want to save the computed hash

* **Copy hash to clipboard**
* _Disabled by default_
* The program will copy the computed hash to the clipboard

* **Check for updates**
* _Disabled by default_
* The program will connect to GitHub servers to check if the current version is up to date

All settings are stored inside a `user.cfg` file, in the same directory as SuperBLT Hasher.
> superblthasher-cli <span class="h-s">"D:\Path\To Mod\Folder"</span>
## Screenshot

<a href="https://strappazzon.github.io/PD2-SuperBLT-Hasher/static/img/screenshot.png">
<img src="https://strappazzon.github.io/PD2-SuperBLT-Hasher/static/img/screenshot.png" alt="SuperBLT Hasher Screenshot">
<a href="static/img/screenshot.png">
<img src="static/img/screenshot.png" alt="SuperBLT Hasher GUI Screenshot">
</a>

## Download
Expand All @@ -86,7 +61,7 @@ The complete SuperBLT Hasher source code is available [on GitHub](https://github

By downloading and/or using SuperBLT Hasher, you are agreeing to the license terms.

> Copyright (c) 2020 Alberto Strappazzon
> Copyright (c) 2020 - 2021 Alberto Strappazzon
>
> Permission is hereby granted, free of charge, to any person obtaining a copy
> of this software and associated documentation files (the "Software"), to deal
Expand Down
Binary file modified docs/static/img/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 89b03ff

Please sign in to comment.