Skip to content

Commit 420c3e6

Browse files
authored
docs: clean up readmes (#117)
1 parent 82073d1 commit 420c3e6

File tree

3 files changed

+26
-12
lines changed

3 files changed

+26
-12
lines changed

cli/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ $ cql2 -o json < tests/fixtures/text/example01.txt
3535
Use `-v` to get detailed validation information:
3636

3737
```shell
38-
$ cql2 'wrong' -v
38+
$ cql2 'wrong' -v
3939
[ERROR] Invalid CQL2: wrong
4040
For more detailed validation information, use -vv
4141
jsonschema validation failed with file:///tmp/cql2.json#
@@ -58,7 +58,7 @@ jsonschema validation failed with file:///tmp/cql2.json#
5858
cql2-text parsing errors are pretty-printed:
5959

6060
```shell
61-
$ cql2 '(foo ~= "bar")'
61+
$ cql2 '(foo ~= "bar")'
6262
[ERROR] Parsing error: (foo ~= "bar")
6363
--> 1:6
6464
|
@@ -72,4 +72,4 @@ Use `cql2 --help` to get a complete listing of the CLI arguments and formats.
7272

7373
## More information
7474

75-
See [the top-level README](../README.md) for license and contributing information.
75+
See [the top-level README](https://github.com/developmentseed/cql2-rs/blob/main/README.md) for license and contributing information.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ classifiers = [
1111
"Programming Language :: Python :: 3.13",
1212
"Programming Language :: Python :: 3.14",
1313
]
14-
dynamic = ["version"]
14+
dynamic = ["version", "readme", "summary", "description", "description_content_type", "keywords", "home_page", "author", "author_email", "license", "project_url"]
1515

1616
[project.scripts]
1717
cql2 = "cql2:main"

wasm/README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
11
# cql2-wasm
22

3-
This is a no-release crate to build a small [WebAssembly](https://webassembly.org/) wrapper for this crate.
3+
A small [WebAssembly](https://webassembly.org/) module for parsing and translating [CQL2](https://www.ogc.org/standards/cql2/).
4+
5+
## Usage
6+
7+
Add to your project:
8+
9+
```sh
10+
npm i cql2-wasm
11+
```
12+
13+
Then:
14+
15+
```js
16+
import { CQL2 } from 'cql2-wasm'
17+
18+
const cql2 = new CQL2('collection = foo')
19+
20+
// Parse and display results
21+
console.log('is_valid():', cql2.is_valid())
22+
console.log('to_json():', cql2.to_json())
23+
console.log('to_text():', cql2.to_text())
24+
````
425

526
## Building
627

@@ -29,10 +50,3 @@ wasm-pack test --firefox wasm
2950
```
3051

3152
Then, open <http://127.0.0.1:8000/> to see the test(s) run.
32-
33-
## Releasing to NPM
34-
35-
```shell
36-
wasm-pack build wasm
37-
# TODO actually release
38-
```

0 commit comments

Comments
 (0)