diff --git a/README.md b/README.md index a1e60727f..7227a4eb7 100644 --- a/README.md +++ b/README.md @@ -11,4 +11,5 @@ View the respective directory and their READMEs for more information. * `lxljs` - Utility library * `lxl-web` - New Libris search * `packages/supersearch` - Supersearch component library +* `packages/codemirror-lang-lxlquery` - CodeMirror language support package for Libris XL queries diff --git a/packages/supersearch/README.md b/packages/supersearch/README.md index 16c70df2c..ec134e847 100644 --- a/packages/supersearch/README.md +++ b/packages/supersearch/README.md @@ -1,24 +1,32 @@ -# create-svelte +# supersearch -Everything you need to build a Svelte library, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte). +A [Svelte](https://svelte.dev) search component powered by [CodeMirror](https://codemirror.net/). -Read more about creating a library [in the docs](https://svelte.dev/docs/kit/packaging). +## Installation -## Creating a project +```bash +npm install supersearch +``` -If you're seeing this, you've probably already done this step. Congrats! +## Usage -```bash -# create a new project in the current directory -npx sv create +To use `supersearch` in a Svelte project ... -# create a new project in my-app -npx sv create my-app -``` +To use `supersearch` in a non-Svelte project ... + +## Properties + +| Property | Type | Description | Default value | +| ------------- | ----------------- | ----------------------------------------------------------------- | ------------- | +| `name` | `string` | A string specifying a name for the form control. | `undefined` | +| `value` | `string` | The value that will be displayed and edited inside the component. | `""` | +| `form` | `string` | A string matching the `id` of a `