doc: Animated SVG on README (#281)

Add animated SVG
aristanetworks · Jul 24, 2023 · 72b65fa · 72b65fa
1 parent a2538cd
commit 72b65fa
Show file tree

Hide file tree

Showing 4 changed files with 77 additions and 10 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -4,15 +4,17 @@
 
 # Arista Network Test Automation (ANTA) Framework
 
-This repository is a Python package to automate tests on Arista devices.
+ANTA is Python framework that automates tests for Arista devices.
 
-- The package name is ANTA, which stands for **Arista Network Test Automation**.
-- This package provides a set of tests to validate the state of your network.
-- This package can be imported in Python scripts:
-  - To automate NRFU (Network Ready For Use) test on a preproduction network
-  - To automate tests on a live network (periodically or on demand)
+- ANTA provides a [set of tests](api/tests.md) to validate the state of your network
+- ANTA can be used to:
+    - Automate NRFU (Network Ready For Use) test on a preproduction network
+    - Automate tests on a live network (periodically or on demand)
+- ANTA can be used with:
+    - The [ANTA CLI](cli/overview.md)
+    - As a [Python library](advanced_usages/as-python-lib.md) in your own application
 
-This repository comes with a cli to run __Arista Network Test Automation__ (ANTA) framework using your preferred shell:
+![anta nrfu](imgs/anta-nrfu.svg)
 
 ```bash
 # Install ANTA CLI
@@ -54,9 +56,6 @@ Commands:
   nrfu   Run NRFU against inventory devices
 ```
 
-![anta nrfu table output](imgs/anta-nrfu-table-output.png)
-
-
 ## Documentation
 
 The documentation is published on [ANTA package website](https://www.anta.ninja)

diff --git a/docs/imgs/animated-svg.md b/docs/imgs/animated-svg.md
@@ -0,0 +1,2 @@
+Repository: https://github.com/marionebl/svg-term-cli
+Command: `cat anta-nrfu.cast | svg-term --height 10 --window --out anta.svg`