Merge pull request #152 from xscriptor/update/plugins

update/plugins

Author: xscriptor

README.md

@@ -7,6 +7,11 @@
 
 <p>A cross-platform system information fetching tool inspired by fastfetch and neofetch, written in Rust.</p>
 
+<a href="https://imgur.com/iKGpg4h">
+<img src="https://i.imgur.com/ihNz93o.gif" width="900" alt="Demo" >
+</a>
+
+
 <!--Menu-->
 <div align="left">
   <h2>Menu</h2>

docs/PLUGINS.md

@@ -97,9 +97,9 @@
 
 <h3>Frame Animation</h3>
 <p>
-  Use <code>style: "frame"</code> con <code>frames_path</code> para animaciones con
-  múltiples frames ASCII. Puedes usar un <strong>solo archivo</strong> con las frames
-  separadas por <code>===</code> en su propia línea, o un <strong>array de archivos</strong>.
+  Use <code>style: "frame"</code> with <code>frames_path</code> for animations with
+  multiple ASCII frames. You can use a <strong>single file</strong> with frames
+  separated by <code>===</code> on their own line, or an <strong>array of files</strong>.
 </p>
 
 <pre><code class="language-jsonc">{
@@ -114,7 +114,7 @@
 }
 </code></pre>
 
-<p>O con múltiples archivos:</p>
+<p>Or with multiple files:</p>
 
 <pre><code class="language-jsonc">{
   "ascii": "~/.config/xfetch/logos/blink_open.txt",

plugins/README.md

@@ -0,0 +1,66 @@
+<h1>Plugins</h1>
+
+<p>
+  xfetch supports third-party plugins that extend its functionality. Plugins run as
+  separate executables and communicate with xfetch over stdin/stdout using a JSON
+  protocol. This keeps the plugin system decoupled, allowing plugins to be installed,
+  removed, and updated independently of the core binary.
+</p>
+
+<h2>Installing a Plugin</h2>
+
+<p>From a local path:</p>
+
+<pre><code>xfetch plugin install ./plugins/my-plugin</code></pre>
+
+<p>From the default remote repository (GitHub):</p>
+
+<pre><code>xfetch plugin install my-plugin</code></pre>
+
+<h2>Listing Installed Plugins</h2>
+
+<pre><code>xfetch plugin list</code></pre>
+
+<h2>Removing a Plugin</h2>
+
+<pre><code>xfetch plugin remove my-plugin</code></pre>
+
+<h2>Available Plugins</h2>
+
+<table>
+  <thead>
+    <tr>
+      <th>Plugin</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><code>animate-logo</code></td>
+      <td>
+        Animates the ASCII logo with multiple styles (sweep, wave, rainbow,
+        sparkle, breathing, frame). See
+        <a href="./animate-logo/README.md">animate-logo/README.md</a>.
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+<h2>Plugin Directory</h2>
+
+<p>
+  Installed plugin binaries are stored in the xfetch plugin directory:
+</p>
+
+<ul>
+  <li><strong>Linux/macOS:</strong> <code>~/.config/xfetch/plugins/</code></li>
+  <li><strong>Windows:</strong> <code>%APPDATA%/xfetch/plugins/</code></li>
+</ul>
+
+<h2>Creating a Plugin</h2>
+
+<p>
+  See <a href="./docs/README.md">plugins/docs/README.md</a> for the full
+  plugin development guide, including the protocol specification, conventions,
+  and contribution guidelines.
+</p>

plugins/animate-logo/README.md

@@ -76,12 +76,12 @@ All characters fade in and out in a warm amber tone (breathing effect).
 
 ### `frame` — ASCII Frame Animation
 
-Cycles through multiple ASCII art frames to create animations. Puedes definirlas
-como un **array de archivos** o en un **solo archivo** separado por `===`:
+Cycles through multiple ASCII art frames to create animations. You can define them
+as an **array of files** or in a **single file** separated by `===`:
 
-#### Un solo archivo con separador `===`
+#### Single file with `===` separator
 
-Crea un archivo (ej. `blink.txt`) con todas las frames separadas por `===`:
+Create a file (e.g. `blink.txt`) with all frames separated by `===`:
 
 ```
   .---.
@@ -122,7 +122,7 @@ Crea un archivo (ej. `blink.txt`) con todas las frames separadas por `===`:
 }
 ```
 
-#### Múltiples archivos
+#### Multiple files
 
 ```jsonc
 {
@@ -142,8 +142,8 @@ Crea un archivo (ej. `blink.txt`) con todas las frames separadas por `===`:
 }
 ```
 
-> El campo `ascii` se usa como fallback estático.
-> Pon `fps` bajo (2-6) para animaciones por frames. El delimitador debe ir en su propia línea.
+> The `ascii` field is used as a static fallback.
+> Use low `fps` (2-6) for frame animations. The delimiter must be on its own line.
 
 ### `none`
 
@@ -176,7 +176,7 @@ plugins/animate-logo/assets/xfetch_logo.txt
 
 ### Blinking Eye (frame animation)
 
-Incluido en un solo archivo:
+Included in a single file:
 
 ```
 plugins/animate-logo/assets/blink.txt

plugins/animate-logo/assets/blink.txt

@@ -20,4 +20,10 @@
  /     \
 | O   O |
 |  ---  |
+ \_____/
+===
+  .---.
+ /     \
+| O   O |
+|   ^   |
  \_____/