Merge pull request #56 from maysunfaisal/updateReadme-2

Provide code snippets in ReadMe

Author: maysunfaisal

README.md

@@ -9,8 +9,30 @@ The Devfile Parser library is a Golang module that:
 4. defines util functions for the devfile.
 
 The function documentation can be accessed via [pkg.go.dev](https://pkg.go.dev/github.com/devfile/library). 
-1. To parse a devfile, visit pkg/devfile/parse.go
-2. To get the Kubernetes structs from the devfile, visit pkg/devfile/generator/generators.go
+1. To parse a devfile, visit pkg/devfile/parse.go 
+    ```
+    // Parses the devfile and validates the devfile data
+    devfile, err := devfilePkg.ParseAndValidate(devfileLocation)
+
+    // To get all the components from the devfile
+    components, err := devfile.Data.GetComponents(DevfileOptions{})
+    ```
+2. To get the Kubernetes objects from the devfile, visit pkg/devfile/generator/generators.go
+   ```
+    // To get a slice of Kubernetes containers of type corev1.Container from the devfile component containers
+    containers, err := generator.GetContainers(devfile)
+
+    // To generate a Kubernetes deployment of type v1.Deployment
+    deployParams := generator.DeploymentParams{
+		TypeMeta:          generator.GetTypeMeta(deploymentKind, deploymentAPIVersion),
+		ObjectMeta:        generator.GetObjectMeta(name, namespace, labels, annotations),
+		InitContainers:    initContainers,
+		Containers:        containers,
+		Volumes:           volumes,
+		PodSelectorLabels: labels,
+	}
+	deployment := generator.GetDeployment(deployParams)
+   ```
 
 ## Usage