Skip to content

Commit

Permalink
docs: Update README; add license
Browse files Browse the repository at this point in the history
  • Loading branch information
kyleconroy committed Nov 2, 2023
1 parent db6edb7 commit 927ea5a
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 11 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 927ea5a

Please sign in to comment.