From c1364d09d91dc1d66156404fe4987a1f362d3028 Mon Sep 17 00:00:00 2001
From: Serwan Asaad <serwan.asaad@quantum-machines.co>
Date: Tue, 15 Oct 2024 19:19:04 +0200
Subject: [PATCH] update main example in docs

---
 README.md     | 10 +++++-----
 docs/index.md | 21 ++++++++++-----------
 2 files changed, 15 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 97bd9e8..a2ad0c6 100644
--- a/README.md
+++ b/README.md
@@ -30,12 +30,12 @@ from qm import qua
 # Create a root-level QuAM instance
 machine = BasicQuAM()
 
-# Add an OPX output channel
-channel = SingleChannel(opx_output=("con1", 1))
-machine.channels["output"] = channel
+# Add a qubit connected to an OPX output channel
+qubit = SingleChannel(opx_output=("con1", 1))
+machine.channels["qubit"] = qubit
 
 # Add a Gaussian pulse to the channel
-channel.operations["gaussian"] = pulses.GaussianPulse(
+qubit.operations["gaussian"] = pulses.GaussianPulse(
     length=100,  # Pulse length in ns
     amplitude=0.5,  # Peak amplitude of Gaussian pulse
     sigma=20,  # Standard deviation of Guassian pulse
@@ -43,7 +43,7 @@ channel.operations["gaussian"] = pulses.GaussianPulse(
 
 # Play the Gaussian pulse on the channel within a QUA program
 with qua.program() as prog:
-    channel.play("gaussian")
+    qubit.play("gaussian")
 
 # Generate the QUA configuration from QuAM
 qua_configuration = machine.generate_config()
diff --git a/docs/index.md b/docs/index.md
index 812146d..23668a9 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -18,30 +18,29 @@ QuAM is not just a tool but a gateway to streamlined and efficient quantum compu
 - **State Management:** Effortlessly save and load your QuAM state, enabling consistent results and reproducibility in experiments.
 
 ```python
-from quam.components import *
+from quam.components import BasicQuAM, SingleChannel, pulses
 from qm import qua
 
 # Create a root-level QuAM instance
 machine = BasicQuAM()
 
-# Add an OPX output channel
-channel = SingleChannel(opx_output=("con1", 1))
-machine.channels["output"] = channel
+# Add a qubit connected to an OPX output channel
+qubit = SingleChannel(opx_output=("con1", 1))
+machine.channels["qubit"] = qubit
 
 # Add a Gaussian pulse to the channel
-channel.operations["gaussian"] = pulses.GaussianPulse(
-    length=100, amplitude=0.5, sigma=20
+qubit.operations["gaussian"] = pulses.GaussianPulse(
+    length=100,  # Pulse length in ns
+    amplitude=0.5,  # Peak amplitude of Gaussian pulse
+    sigma=20,  # Standard deviation of Guassian pulse
 )
 
-# Play the Gaussian pulse within a QUA program
+# Play the Gaussian pulse on the channel within a QUA program
 with qua.program() as prog:
-    channel.play("gaussian")
+    qubit.play("gaussian")
 
 # Generate the QUA configuration from QuAM
 qua_configuration = machine.generate_config()
-
-# Save QuAM to a JSON file
-machine.save("state.json")
 ```
 </div>