aboutsummaryrefslogtreecommitdiffstats
path: root/docs/usage/intro.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/usage/intro.rst')
-rw-r--r--docs/usage/intro.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/usage/intro.rst b/docs/usage/intro.rst
new file mode 100644
index 0000000..7031c13
--- /dev/null
+++ b/docs/usage/intro.rst
@@ -0,0 +1,16 @@
+Introduction
+############
+
+It *should* be simple to use.
+Once you have installed the Python module, few lines of code are needed to
+onboard a Service:
+
+.. code:: Python
+
+ from onapsdk.vf import Vf
+ from onapsdk.service import Service
+
+ # We assume here that the VF has been already onboarded
+ vf = VF(name="myVF")
+ service = Service(name="myService", resources=[vf])
+ service.onboard()