Skip to content

Commit

Permalink
Dedicated readme for package folder
Browse files Browse the repository at this point in the history
  • Loading branch information
langsamu committed Apr 14, 2021
1 parent 680085f commit 161baad
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 6 deletions.
28 changes: 25 additions & 3 deletions package/README.md
Original file line number Diff line number Diff line change
@@ -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)
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/).
4 changes: 2 additions & 2 deletions package/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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",
Expand Down

0 comments on commit 161baad

Please sign in to comment.