33## Table of Contents <!-- omit in toc -->
44
55- [ Overview] ( #overview )
6- - [ Installation] ( #installation )
7- - [ Building Locally] ( #building-locally )
8- - [ Running Tests] ( #running-tests )
9- - [ Running the Example CLI] ( #running-the-example-cli )
6+ - [ Install] ( #install )
107- [ Translating Quick SQL into Oracle SQL Data Definition Language (DDL)] ( #translating-quick-sql-into-oracle-sql-data-definition-language-ddl )
118 - [ DDL NodeJS ECMA Script Module (ESM) Example] ( #ddl-nodejs-ecma-script-module-esm-example )
129 - [ DDL NodeJS Common JS (CJS) Example] ( #ddl-nodejs-common-js-cjs-example )
@@ -34,39 +31,10 @@ module that can be used as seen in the example below:
3431
3532![ Quick ERD] ( ./assets/quick-erd-dark.png )
3633
37- ## Installation
38-
39- 1 . Open a terminal window
40- 2 . Clone the repository
41- 3 . Change into the cloned repository directory
42- 4 . Install dependencies by running
43-
44- ``` bash
45- npm install
46- ```
47-
48- # # Building Locally
49-
50- Once you have set up the project, you can build the library by executing:
34+ ## Install
5135
5236``` bash
53- npm run build
54- ` ` `
55-
56- # # Running Tests
57-
58- Once you have set up the project, you can run the test suite by executing:
59-
60- ` ` ` bash
61- npm run test
62- ` ` `
63-
64- # # Running the Example CLI
65-
66- Once you have built the library, you can run the example CLI by executing:
67-
68- ` ` ` bash
69- npm run example-cli -- ./test/department_employees.quicksql
37+ npm install @oracle/quicksql
7038```
7139
7240## Translating Quick SQL into Oracle SQL Data Definition Language (DDL)
@@ -81,12 +49,12 @@ See below for examples of how to use this library.
8149### DDL NodeJS ECMA Script Module (ESM) Example
8250
8351``` js
84- import quickSQL from "./dist/quick-sql.js ";
52+ import { toDDL } from " @oracle/quicksql " ;
8553import fs from " fs" ;
8654
8755try {
8856 const text = fs .readFileSync ( ' ./test/department_employees.quicksql' );
89- console.log( quickSQL. toDDL( text.toString() ) );
57+ console .log ( toDDL ( text .toString () ) );
9058} catch ( e ) {
9159 console .error ( e );
9260};
@@ -95,12 +63,12 @@ try {
9563### DDL NodeJS Common JS (CJS) Example
9664
9765``` js
98- const quickSQL = require( "./dist/quick-sql.umd.cjs " );
66+ const { toDDL } = require ( " @oracle/quicksql " );
9967const fs = require ( " fs" );
10068
10169try {
10270 const text = fs .readFileSync ( ' ./test/department_employees.quicksql' );
103- console.log( quickSQL. toDDL( text.toString() ) );
71+ console .log ( toDDL ( text .toString () ) );
10472} catch ( e ) {
10573 console .error ( e );
10674};
11078
11179``` html
11280<script type =" module" >
113- import quickSQL from ' ./dist/quick-sql.js' ;
114- document.body.innerText = quickSQL. toDDL(
81+ import { toDDL } from ' ./dist/quick-sql.js' ;
82+ document .body .innerText = toDDL (
11583` departments /insert 2
11684 name /nn
11785 location
0 commit comments