From 161baaddddc61f57879234646f948d199dd032ef Mon Sep 17 00:00:00 2001 From: Samu Lang Date: Wed, 14 Apr 2021 12:01:01 +0100 Subject: [PATCH] Dedicated readme for package folder --- package/README.md | 28 +++++++++++++++++++++++++--- package/package-lock.json | 4 ++-- package/package.json | 3 ++- 3 files changed, 29 insertions(+), 6 deletions(-) diff --git a/package/README.md b/package/README.md index 90f7c6f6..8d71ec20 100644 --- a/package/README.md +++ b/package/README.md @@ -1,5 +1,27 @@ -# SPARQL Blockly npm package +# SPARQL Blockly -Source-code for the [SPARQL Blockly npm package](https://www.npmjs.com/package/sparql-blockly). +[![Build Status](https://github.com/langsamu/sparql-blockly/actions/workflows/ci.yml/badge.svg)](https://github.com/langsamu/sparql-blockly/actions) +[![code coverage](https://codecov.io/gh/langsamu/sparql-blockly/branch/main/graph/badge.svg?token=X55Y21AMAE)](https://codecov.io/gh/langsamu/sparql-blockly) -[Usage examples](../examples) \ No newline at end of file +SPARQL Blockly is a library for visualising and building SPARQL. + +## Usage +- **[Try it online](https://langsamu.github.io/sparql-blockly/)** +- See the [examples](../examples) + +## Features + +SPARQL Blockly implements the [SPARQL](https://www.w3.org/TR/sparql11-query/) grammar in [Blockly](https://developers.google.com/blockly). + +It supports SPARQL 1.1 Query, Update and SPARQL*. + +![screenshot](../screenshot.png) + +It enables several ways of visual interaction with SPARQL: +- Dragging blocks from a toolbox unto a canvas to assemble valid queries. +- Adding clauses and patterns to query blocks using a context menu. +- Parsing SPARQL query text into blocks. +- Collapsing/expanding parts of a query assemblage. +- Sharing URLs of visual representations. + +SPARQL is parsed using [SPARQL.js](https://github.com/RubenVerborgh/SPARQL.js/). diff --git a/package/package-lock.json b/package/package-lock.json index a818ea18..17f33e35 100644 --- a/package/package-lock.json +++ b/package/package-lock.json @@ -1,12 +1,12 @@ { "name": "sparql-blockly", - "version": "1.0.0", + "version": "1.0.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "sparql-blockly", - "version": "1.0.0", + "version": "1.0.1", "license": "MIT", "dependencies": { "@rdfjs/term-map": "^1.0.0", diff --git a/package/package.json b/package/package.json index 357197f9..6ee4ff7d 100644 --- a/package/package.json +++ b/package/package.json @@ -1,6 +1,6 @@ { "name": "sparql-blockly", - "version": "1.0.0", + "version": "1.0.1", "description": "A library for working with SPARQL in Blockly", "main": "dist/index.js", "license": "MIT", @@ -20,6 +20,7 @@ "url": "https://github.com/langsamu/sparql-blockly.git", "directory": "package" }, + "homepage": "https://langsamu.github.io/sparql-blockly/", "files": [ "dist", "index.d.ts",