Skip to content

Commit e65f9b6

Browse files
committed
update deps
1 parent e4b8bbb commit e65f9b6

File tree

5 files changed

+555
-1783
lines changed

5 files changed

+555
-1783
lines changed

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,15 @@
88

99
</div>
1010

11-
A standard web component to easily deploy a user-friendly [SPARQL](https://www.w3.org/TR/sparql12-query/) query editor for one or more endpoints. Built on the popular [YASGUI editor](https://github.com/zazuko/Yasgui), it provides context-aware autocomplete for classes and predicates based on the content of the endpoints.
11+
A user-friendly [SPARQL](https://www.w3.org/TR/sparql12-query/) query editor built on the popular [YASGUI editor](https://github.com/zazuko/Yasgui), it provides context-aware autocomplete for classes and predicates based on the content of the endpoints, as well as query examples.
1212

13-
The editor retrieves metadata about the endpoints by directly querying them, so all that is needed is to generate and upload some metadata to each endpoints, and it works on top of any triplestore without configuration needed. Reducing the need for complex infrastructure, while making your SPARQL endpoints easier to query for users and machines.
13+
Use it directly for any endpoint at **[sib-swiss.github.io/sparql-editor](https://sib-swiss.github.io/sparql-editor)**.
1414

15-
> [!TIP]
16-
>
17-
> 👆️ **Try it** with [SIB](https://www.sib.swiss/) endpoints, such as UniProt and Bgee, at **[sib-swiss.github.io/sparql-editor](https://sib-swiss.github.io/sparql-editor)**
15+
The editor retrieves metadata about the endpoints by directly querying them, or searching in the SPARQL service description. So all that is needed is to generate and upload some metadata to each endpoints, and it works on top of any triplestore without configuration needed. Reducing the need for complex infrastructure, while making your SPARQL endpoints easier to query for users and machines.
16+
17+
You can also redeploy it for a specific endpoint, or set of endpoints using the standard web component documented below,
18+
19+
## 🪄 Features
1820

1921
- **✨ Autocomplete possibilities for properties and classes** are automatically pulled from the endpoints based on the [VoID description](https://www.w3.org/TR/void/) present in the triplestore. The suggested properties are contextually filtered based on the class of the subject at the cursor's position, and are aware of `SERVICE` clauses, ensuring relevant autocompletion even in federated queries. Checkout the [`void-generator`](https://github.com/JervenBolleman/void-generator) project to automatically generate VoID description for your endpoint.
2022

@@ -74,6 +76,8 @@ The editor retrieves metadata about the endpoints by directly querying them, so
7476
ORDER BY ?prefix
7577
```
7678

79+
- **🗺️ Overview of classes** using the VoID description.
80+
7781
</details>
7882

7983
![Screenshot gene](packages/demo/src/screenshot_gene.png)
@@ -84,18 +88,22 @@ The editor retrieves metadata about the endpoints by directly querying them, so
8488

8589
## 🚀 Use
8690

87-
1. Import from a CDN:
91+
1. Install with a package manager in your project:
8892

89-
```html
90-
<script type="module" src="https://unpkg.com/@sib-swiss/sparql-editor"></script>
93+
```bash
94+
npm i --save @sib-swiss/sparql-editor
9195
```
9296

93-
Or install with a package manager in your project:
97+
And import in your JS/TS file with:
9498

95-
```bash
96-
npm install --save @sib-swiss/sparql-editor
97-
# or
98-
pnpm add @sib-swiss/sparql-editor
99+
```ts
100+
import "@sib-swiss/sparql-editor";
101+
```
102+
103+
Or directly import from a CDN:
104+
105+
```html
106+
<script type="module" src="https://unpkg.com/@sib-swiss/sparql-editor"></script>
99107
```
100108

101109
2. Use the custom element in your HTML/JSX/TSX code:

0 commit comments

Comments
 (0)