From 927ea5a70c1695ce82906d0b562b8531b7e0698e Mon Sep 17 00:00:00 2001 From: Kyle Conroy Date: Thu, 2 Nov 2023 10:46:46 -0700 Subject: [PATCH] docs: Update README; add license --- LICENSE | 21 +++++++++++++++++++++ README.md | 24 +++++++++++++----------- 2 files changed, 34 insertions(+), 11 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..335c6d2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Kyle Conroy + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 41acb7b..94d6335 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ ## Usage +> [!IMPORTANT] +> This repository is a read-only portion of https://github.com/sqlc-dev/sqlc. + ```yaml version: '2' plugins: -- name: py +- name: golang wasm: - url: https://downloads.sqlc.dev/plugin/sqlc-gen-python_1.0.0.wasm - sha256: "FIXME" + url: "https://example.com" + sha256: "" sql: -- schema: "schema.sql" - queries: "query.sql" +- schema: schema.sql + queries: query.sql engine: postgresql codegen: - - out: src/authors - plugin: py + - plugin: golang + out: db options: - package: authors - emit_sync_querier: true - emit_async_querier: true -``` + package: db + sql_package: pgx/v5 +``` \ No newline at end of file