Skip to content

docs: clean up readmes #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 12, 2025
Merged

docs: clean up readmes #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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#
Expand All @@ -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
|
Expand All @@ -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.
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
30 changes: 22 additions & 8 deletions wasm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -29,10 +50,3 @@ wasm-pack test --firefox wasm
```

Then, open <http://127.0.0.1:8000/> to see the test(s) run.

## Releasing to NPM

```shell
wasm-pack build wasm
# TODO actually release
```