Skip to content

Commit 161baad

Browse files
committed
Dedicated readme for package folder
1 parent 680085f commit 161baad

File tree

3 files changed

+29
-6
lines changed

3 files changed

+29
-6
lines changed

package/README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
1-
# SPARQL Blockly npm package
1+
# SPARQL Blockly
22

3-
Source-code for the [SPARQL Blockly npm package](https://www.npmjs.com/package/sparql-blockly).
3+
[![Build Status](https://github.com/langsamu/sparql-blockly/actions/workflows/ci.yml/badge.svg)](https://github.com/langsamu/sparql-blockly/actions)
4+
[![code coverage](https://codecov.io/gh/langsamu/sparql-blockly/branch/main/graph/badge.svg?token=X55Y21AMAE)](https://codecov.io/gh/langsamu/sparql-blockly)
45

5-
[Usage examples](../examples)
6+
SPARQL Blockly is a library for visualising and building SPARQL.
7+
8+
## Usage
9+
- **[Try it online](https://langsamu.github.io/sparql-blockly/)**
10+
- See the [examples](../examples)
11+
12+
## Features
13+
14+
SPARQL Blockly implements the [SPARQL](https://www.w3.org/TR/sparql11-query/) grammar in [Blockly](https://developers.google.com/blockly).
15+
16+
It supports SPARQL 1.1 Query, Update and SPARQL*.
17+
18+
![screenshot](../screenshot.png)
19+
20+
It enables several ways of visual interaction with SPARQL:
21+
- Dragging blocks from a toolbox unto a canvas to assemble valid queries.
22+
- Adding clauses and patterns to query blocks using a context menu.
23+
- Parsing SPARQL query text into blocks.
24+
- Collapsing/expanding parts of a query assemblage.
25+
- Sharing URLs of visual representations.
26+
27+
SPARQL is parsed using [SPARQL.js](https://github.com/RubenVerborgh/SPARQL.js/).

package/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "sparql-blockly",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "A library for working with SPARQL in Blockly",
55
"main": "dist/index.js",
66
"license": "MIT",
@@ -20,6 +20,7 @@
2020
"url": "https://github.com/langsamu/sparql-blockly.git",
2121
"directory": "package"
2222
},
23+
"homepage": "https://langsamu.github.io/sparql-blockly/",
2324
"files": [
2425
"dist",
2526
"index.d.ts",

0 commit comments

Comments
 (0)