From f05aba4d6ae32eba47e926a3dd0c079e2f62934a Mon Sep 17 00:00:00 2001 From: Pete Gadomski Date: Wed, 12 Nov 2025 08:27:01 -0700 Subject: [PATCH] docs: clean up readmes --- cli/README.md | 6 +++--- pyproject.toml | 2 +- wasm/README.md | 30 ++++++++++++++++++++++-------- 3 files changed, 26 insertions(+), 12 deletions(-) diff --git a/cli/README.md b/cli/README.md index a53a2f7..3257438 100644 --- a/cli/README.md +++ b/cli/README.md @@ -35,7 +35,7 @@ $ cql2 -o json < tests/fixtures/text/example01.txt Use `-v` to get detailed validation information: ```shell -$ cql2 'wrong' -v +$ cql2 'wrong' -v [ERROR] Invalid CQL2: wrong For more detailed validation information, use -vv jsonschema validation failed with file:///tmp/cql2.json# @@ -58,7 +58,7 @@ jsonschema validation failed with file:///tmp/cql2.json# cql2-text parsing errors are pretty-printed: ```shell -$ cql2 '(foo ~= "bar")' +$ cql2 '(foo ~= "bar")' [ERROR] Parsing error: (foo ~= "bar") --> 1:6 | @@ -72,4 +72,4 @@ Use `cql2 --help` to get a complete listing of the CLI arguments and formats. ## More information -See [the top-level README](../README.md) for license and contributing information. +See [the top-level README](https://github.com/developmentseed/cql2-rs/blob/main/README.md) for license and contributing information. diff --git a/pyproject.toml b/pyproject.toml index fc1b634..05fee4e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -11,7 +11,7 @@ classifiers = [ "Programming Language :: Python :: 3.13", "Programming Language :: Python :: 3.14", ] -dynamic = ["version"] +dynamic = ["version", "readme", "summary", "description", "description_content_type", "keywords", "home_page", "author", "author_email", "license", "project_url"] [project.scripts] cql2 = "cql2:main" diff --git a/wasm/README.md b/wasm/README.md index d8041a3..e7d89f3 100644 --- a/wasm/README.md +++ b/wasm/README.md @@ -1,6 +1,27 @@ # cql2-wasm -This is a no-release crate to build a small [WebAssembly](https://webassembly.org/) wrapper for this crate. +A small [WebAssembly](https://webassembly.org/) module for parsing and translating [CQL2](https://www.ogc.org/standards/cql2/). + +## Usage + +Add to your project: + +```sh +npm i cql2-wasm +``` + +Then: + +```js +import { CQL2 } from 'cql2-wasm' + +const cql2 = new CQL2('collection = foo') + +// Parse and display results +console.log('is_valid():', cql2.is_valid()) +console.log('to_json():', cql2.to_json()) +console.log('to_text():', cql2.to_text()) +```` ## Building @@ -29,10 +50,3 @@ wasm-pack test --firefox wasm ``` Then, open to see the test(s) run. - -## Releasing to NPM - -```shell -wasm-pack build wasm -# TODO actually release -```