docs: adjust to new dockerhub org

ppfeister · Aug 10, 2024 · 23b1fb4 · 23b1fb4
1 parent a160525
commit 23b1fb4
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 30 deletions.
diff --git a/.github/README.md b/.github/README.md
@@ -47,29 +47,19 @@ Personal Access Token (PAT) is required for PGP scraping, but all other function
 | Voter Records | Geographical, relation, and age lookup in 18 US States |
 
 
-### Helpers and utilities
+## Quick Start
 
-| Name | Description |
-| --- | --- |
-| [__FlareSolverr__][flaresolverr] | Proxy server to add support for additional target types |
-
-
-## Usage
-
-`sylva search <query>` will search all available modules for the given query.
-
-`sylva branch <query>` will search all available modules for the given query, merge and deduplicate results, and resume searching with the newly found identities up to a certain depth. Some modules, particularly those with low API limits, may be branch disabled by default.
-
-`sylva config --edit` to edit the configuration file (including API keys).
-
-## Installation
-
-Docker is the preferred method of installation, providing the most consistent experience.
+Docker is the preferred method of installation, providing the most consistent and predictable user experience.
 
 ```bash
-docker run --rm -it ppfeister/sylva sylva search <query>
+docker run --rm -it sylva/sylva --help
 ```
 
+> [!TIP]
+> Some users may opt to add an alias to their shell for ease of use.
+>
+> Adding `alias sd="docker run --rm -it sylva/sylva"` to your ~/.bashrc or ~/.zshrc will allow you to simply type `sd branch user123` rather than the entire docker command.
+
 Other installation methods are described on the [__Sylva Wiki__][wiki-install].
 
 ### Packagers

diff --git a/docs/install.md b/docs/install.md
@@ -6,40 +6,35 @@ Sylva performs best as a Docker container, but several other methods are and wil
 ## Docker
 
 !!! tip
-    The default image reflects the latest tagged release. To fetch the HEAD of `master`, use `ppfeister/sylva:preview`.
+    The default image reflects the latest tagged release. To fetch the HEAD of `master`, use `sylva/sylva:preview`.
 
 ```bash
-docker run --rm ppfeister/sylva sylva search <query> #(1)!
+docker run -it sylva/sylva branch <query> #(1)!
 ```
 
 1.  Sylva can be found on both [Docker Hub][dockerhub]{:target="_blank"} and [GitHub Container Registry][ghcr]{:target="_blank"}.
     Users who prefer the latter can opt for `ghcr.io/ppfeister/sylva` instead.
 
-```bash
-# Alternatively...
-docker run --rm -it ppfeister/sylva bash #(1)!
-sylva search <query>
-```
-
-1.  Sylva can be found on both [Docker Hub][dockerhub]{:target="_blank"} and [GitHub Container Registry][ghcr]{:target="_blank"}.
-    Users who prefer the latter can opt for `ghcr.io/ppfeister/sylva` instead.
+`-it` isn't strictly necessary, but it's recommended for now to more readily allow full [DataFrame][pandas.DataFrame]{:target="_blank"} dumps. In the future, this will be handled in a prettier and more user-friendly way.
 
 ___
 
 ## Docker Compose
 
+The compose file will become more useful later on, as environment variables, persistent volumes, and other configuration options are added.
+
 ```yaml
 services:
   sylva:
     container_name: sylva
-    image: 'ppfeister/sylva' #(1)!
+    image: 'sylva/sylva' #(1)!
 ```
 
 1.  Sylva can be found on both [Docker Hub][dockerhub]{:target="_blank"} and [GitHub Container Registry][ghcr]{:target="_blank"}.
     Users who prefer the latter can opt for `ghcr.io/ppfeister/sylva` instead.
 
 ```bash
-docker compose run --rm sylva sylva search <query>
+docker compose run -it sylva branch <query>
 ```
 
 ___