Skip to content

Commit

Permalink
feat: Instructions page has a basic guide
Browse files Browse the repository at this point in the history
  • Loading branch information
alifeinbinary committed Oct 9, 2024
1 parent 79c04ba commit bd99b80
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 6 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "stegg",
"private": true,
"version": "1.0.0",
"homepage": ".",
"homepage": "https://stegg.alifeinbinary.com/",
"type": "module",
"scripts": {
"dev": "vite",
Expand Down
57 changes: 54 additions & 3 deletions src/routes/Instructions.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,63 @@
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

import { faFloppyDisk, faKeyboard, faLock, faPaperPlane } from "@fortawesome/free-solid-svg-icons";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";

const Instructions: React.FC = () => {
return (
<div>
<h1 className="mb-4 mt-8 text-4xl font-extrabold leading-none tracking-tight text-gray-900 md:text-5xl lg:text-6xl dark:text-white w-2/3">Instructions</h1>

<p className="mb-6 font-light text-gray-500 lg:text-lg dark:text-gray-400 w-2/3">Click on the "How it Works" tab to see how to use the image generator.</p>
<div className="grid gap-12 grid-cols-2 sm:grid-cols-1">
<div className="ml-4 mt-4">
<h1 className="mb-4 mt-8 text-4xl font-extrabold leading-none tracking-tight text-gray-900 md:text-5xl lg:text-6xl dark:text-white w-2/3">Instructions</h1>
<ol className="relative text-gray-500 border-s border-gray-200 dark:border-gray-700 dark:text-gray-400">
<li className="mb-10 ms-6">
<span className="absolute flex items-center justify-center w-8 h-8 bg-green-200 rounded-full -start-4 ring-4 ring-white dark:ring-gray-900 dark:bg-green-900">
<FontAwesomeIcon icon={faKeyboard} className="w-3.5 h-3.5 text-green-500 dark:text-green-400" />
</span>
<h3 className="font-medium leading-tight">Type your message</h3>
<p className="text-sm">Using the <b>Create</b> field you can type the message that you would like to be hidden within the image you're about to create.</p>
</li>
<li className="mb-10 ms-6">
<span className="absolute flex items-center justify-center w-8 h-8 bg-gray-100 rounded-full -start-4 ring-4 ring-white dark:ring-gray-900 dark:bg-gray-700">
<FontAwesomeIcon icon={faLock} className="w-3.5 h-3.5 text-gray-500 dark:text-gray-400" />
</span>
<h3 className="font-medium leading-tight">Choose a password</h3>
<p className="text-sm">If you want to secure the embedded message in the image behind powerful encryption then toggle the lock icon and type a password. You will need to share this password with others if you want them to be able to decode the message, so be sure to remember it.</p>
</li>
<li className="mb-10 ms-6">
<span className="absolute flex items-center justify-center w-8 h-8 bg-gray-100 rounded-full -start-4 ring-4 ring-white dark:ring-gray-900 dark:bg-gray-700">
<FontAwesomeIcon icon={faFloppyDisk} className="w-3.5 h-3.5 text-gray-500 dark:text-gray-400" />
</span>
<h3 className="font-medium leading-tight">Save the image</h3>
<p className="text-sm">This is the best time to save the image in it's highest quality. The image will be saved to your computer or device as a .png file after selecting from the dropdown menu of image dimensions. </p>
</li>
<li className="ms-6">
<span className="absolute flex items-center justify-center w-8 h-8 bg-gray-100 rounded-full -start-4 ring-4 ring-white dark:ring-gray-900 dark:bg-gray-700">
<FontAwesomeIcon icon={faPaperPlane} className="w-3.5 h-3.5 text-gray-500 dark:text-gray-400" />
</span>
<h3 className="font-medium leading-tight">Post (optional)</h3>
<p className="text-sm">You can share the image publicly by clicking the Post button. You can choose to enter a name or psuedonym that will be shown alongside the image or leave it blank to post anonymously.</p>
<p className="text-sm mt-2">Click the "copy link" button on your newly created posted in the feed and share it with any third-parties along with the password.</p>
</li>
</ol>
<p className="mt-8 font-bold">All image and database information associated with the post will be deleted after 1 week.</p>
</div>

<div className="mt-16">
<div className=" p-4 bg-white rounded shadow-md dark:bg-gray-800">
<h2 className="text-lg font-bold text-gray-900 dark:text-white">Steganography</h2>
<p className="text-sm text-gray-500 dark:text-gray-400">noun</p>
<blockquote className="pl-4 border-l-4 border-gray-300 dark:border-gray-700">
<p className="text-sm text-gray-500 dark:text-gray-400">
the practice of hiding secret information within a nonsecret message, image, or other medium in such a way that the very existence of the secret information is not apparent
</p>
<footer className="text-xs text-gray-500 dark:text-gray-400">
— Merriam-Webster Dictionary
</footer>
</blockquote>
</div>
</div>
</div>
);
}
Expand Down
4 changes: 2 additions & 2 deletions vite.config.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import react from "@vitejs/plugin-react";
import { visualizer } from "rollup-plugin-visualizer";
import { defineConfig } from "vite";
import viteCompression from "vite-plugin-compression";
// import viteCompression from "vite-plugin-compression";
import { ViteMinifyPlugin } from "vite-plugin-minify";
import Sitemap from "vite-plugin-sitemap";
import { purgeCss } from "vite-plugin-tailwind-purgecss";
Expand All @@ -18,7 +18,7 @@ export default defineConfig({
},
}),
purgeCss(),
viteCompression({ algorithm: "brotliCompress" }),
// viteCompression({ algorithm: "brotliCompress" }),
visualizer({
filename: "./dist/stats.html",
open: true,
Expand Down

0 comments on commit bd99b80

Please sign in to comment.