瀏覽代碼

HUE-9417. Make NPM-README generic (sree)

sreenaths 5 年之前
父節點
當前提交
353fd2c29d
共有 2 個文件被更改,包括 12 次插入15 次删除
  1. 11 14
      NPM-README.md
  2. 1 1
      docs/docs-site/content/developer/parsers/_index.md

+ 11 - 14
NPM-README.md

@@ -1,21 +1,18 @@
+# GetHue
+GetHue is a collection of various Hue building blocks providing a smart SQL Cloud Editor. They can be classified into two groups, [SQL Parsers](#sql-parsers) and [UI Components](#ui-components). We have collated them into an NPM package for you to easily use in your own app.
 
+# Install
 
-https://docs.gethue.com/developer/api/#sql-autocompletion
+    npm install --save gethue
 
-    npm install gethue
+# SQL Parsers
 
+The parsers are the flagship part of Hue and power extremely advanced autocompletes and other [SQL functionalities](https://docs.gethue.com/user/querying/#autocomplete). They are running on the client side and comes with just a few megabytes of JavaScript that are cached by the browser. This provides a very reactive experience to the end user and allows to [import them](https://docs.gethue.com/developer/parsers#using-hue-parsers-in-your-project) as classic JavaScript modules for your own development needs.
 
-    import sqlAutocompleteParser from 'gethue/parse/sql/hive/hiveAutocompleteParser';
+Please refer the [SQL Parser Documentation](https://docs.gethue.com/developer/parsers/), or this [demo app](https://github.com/cloudera/hue/tree/master/tools/examples/api/hue_dep) for more information.
 
-    const beforeCursor = 'SELECT col1, col2, tbl2.col3 FROM tbl; '; // Note extra space at end
-    const afterCursor = '';
-    const dialect = 'hive';
-    const debug = false;
+# UI Components
 
-    console.log(
-      JSON.stringify(
-        sqlAutocompleteParser.parseSql(beforeCursor, afterCursor, dialect, debug),
-        null,
-        2
-      )
-    );
+Some of the UI elements in Hue are available as generic [Web Components](https://developer.mozilla.org/en-US/docs/Web/Web_Components). They are library/framework agnostic, and can be used in any web project irrespective of what it's built upon - React, Angular, Ember or something else. Internally these components are **created using Vue.js & TypeScript**. So you can even use them as plain Vue component, and take advantage of Vue features.
+
+Please refer the [UI Components Documentation](https://docs.gethue.com/developer/components/) for more information. Page for each component must give you a sound idea on the attributes/props that the components accept, and events they generate. Please refer these [demo apps](https://github.com/cloudera/hue/tree/master/tools/examples/components) for examples on how the components can be used.

+ 1 - 1
docs/docs-site/content/developer/parsers/_index.md

@@ -5,7 +5,7 @@ draft: false
 weight: 4
 ---
 
-The [parsers](/developer/parsers/) are the flagship part of Hue and power extremely advanced autocompletes and other [SQL functionalities](/user/querying/#autocomplete). They are running on the client side and comes with just a few megabytes of JavaScript that are cached by the browser. This provides a very reactive experience to the end user and allows to [import them](#using-hue-parsers-in-your-project) as classic JavaScript modules for your own development needs.
+The parsers are the flagship part of Hue and power extremely advanced autocompletes and other [SQL functionalities](/user/querying/#autocomplete). They are running on the client side and comes with just a few megabytes of JavaScript that are cached by the browser. This provides a very reactive experience to the end user and allows to [import them](#using-hue-parsers-in-your-project) as classic JavaScript modules for your own development needs.
 
 While the dynamic content like the list of tables, columns is obviously fetched via [remote endpoints](#sql-querying), all the SQL knowledge of the statements is available.