docs: add description to readme (#71)

* docs: add description to readme

* Update console_recipe.yaml

* docs: add list of metadata

---------

Co-authored-by: kay_alave <kay.alave@gmail.com>

README.md

@@ -2,6 +2,20 @@
 
 Add your SAP Hana databases to your Linkedin Datahub!
 
+# Description
+This python package extracts views metadata from SAP Hana db to push it to Datahub.  These includes: 
+- Table schema with datatypes
+- View definitions 
+- View lineages with support for cross-schema references and column-level lineages 
+
+The metadata from SAP Hana are extracted and parsed using sqlalchemy (for table lineage) and sqlglot (for column lineage).
+
+### Recipe File
+The recipe file for the source file supports ingestion of both table and column lineage via the Datahub CLI. 
+The ingestion config file can also specify specific schemas to exclude and include, allowing for the creation of lineage across different schemas in a SAP Hana db. 
+Results can be seen in the Datahub UI or printed in the console, or file. 
+
+
 ## Installing
 
 Pre-built Wheels can be downloaded from the [Releases page](https://github.com/contiamo/datahub-sap-hana/releases/latest)

console_recipe.yaml

@@ -30,10 +30,10 @@ source:
       "urn:li:domain:sales":
         allow:
           - "HOTEL"
-#sink: 
-  #type: console"""
-
 sink: 
-  type: file
-  config: 
-    filename: ./sap_hana_results.json
+  type: console
+
+# sink: 
+#   type: file
+#   config: 
+#     filename: ./sap_hana_results.json