Update README and index.html with usage instructions and repository i…

…nformation
ParetoSecurity · Dec 3, 2024 · e6a549f · e6a549f
1 parent 9e7d199
commit e6a549f
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # pareto-linux
 Automatically audit your Linux machine for basic security hygiene.
 
-https://github.com/user-attachments/assets/6c6b2bec-947c-41f8-93f3-f5d15e80e6a8
+
 
 
 ## Installation
@@ -22,10 +22,29 @@ To run a one-time security audit without installation:
 nix run github:paretosecurity/pareto-linux -- check
 ```
 
-or if running from local repo
+or if running from local repo with JSON reporter
+
+```bash
+nix run . -- check --json
+```
+
+This will analyze your system and provide a security report highlighting potential improvements and vulnerabilities.
+
+### Using Debian/Ubuntu/Pop_OS!
+
+See [https://apt.paretosecurity.com](https://apt.paretosecurity.com) for install steps.
+
+
+#### Quick Start
+
+To run a one-time security audit:
 
 ```bash
-nix run . -- check
+paretosecurity check
 ```
 
-This will analyze your system and provide a security report highlighting potential improvements and vulnerabilities.
+or with JSON reporter
+
+```bash
+paretosecurity check --json
+```
diff --git a/apt/index.html b/apt/index.html
@@ -11,7 +11,8 @@
 <body class="bg-gray-100 text-gray-900">
     <div class="container mx-auto p-4">
         <h1 class="text-3xl font-bold mb-4">ParetoSecurity Packages</h1>
-
+        <p class="mb-4">This repository contains packages for ParetoSecurity attestations can be found at
+            https://github.com/ParetoSecurity/pareto-linux/attestations.</p>
         <h3 id="stable" class="text-xl font-semibold mb-2">Stable Release</h3>
         <pre class="bg-gray-800 text-white p-4 rounded">
 # Add paretosecurity gpg key