@faubulous/mentor-rdf 1.0.1 → 1.1.0

package/README.md

@@ -1,14 +1,63 @@
 # Mentor RDF API
 
-A library for working with RDF vocabularies based on the [N3.js](https://github.com/rdfjs/N3.js#readme) library. It provides basic OWL and RDFS inference for retrieving classes, propertis and individuals.
+A TypeScript library for working with RDF vocabularies in Node.js and browsers. It powers the [Mentor](https://github.com/faubulous/mentor-vscode) VS Code extension, providing structured access to ontologies through a repository pattern and lightweight structural reasoning.
 
 - [API Documentation](https://faubulous.github.io/mentor-rdf/)
 - [Test Coverage](https://faubulous.github.io/mentor-rdf/coverage/)
 
+## Features
+
+### Repository Pattern
+Access RDF resources through specialized repositories that provide type-safe, SPARQL-free querying:
+
+- **VocabularyRepository** – Query ontologies and SKOS concept schemes
+- **ClassRepository** – Retrieve OWL/RDFS classes with hierarchy traversal
+- **PropertyRepository** – Access object, datatype, and annotation properties
+- **IndividualRepository** – Query class instances and their properties
+- **ShapeRepository** – Work with SHACL node and property shapes
+
+### Structural Reasoning
+Built-in reasoners expand your RDF graphs with inferred triples:
+
+- **RdfsReasoner** – `rdfs:subClassOf`, `rdfs:subPropertyOf`, domain/range inference
+- **OwlReasoner** – OWL class expressions, property characteristics, equivalences
+- **SkosReasoner** – SKOS concept hierarchies and semantic relations
+- **ShaclReasoner** – SHACL shape target inference
+
+### RDF Store
+An [RDF.js](https://rdf.js.org/)-compatible triple store with:
+
+- Multiple format support: Turtle, N3, N-Triples, N-Quads, TriG, RDF/XML
+- Named graph management
+- Bundled W3C ontologies (RDF, RDFS, OWL, SKOS, SHACL, XSD)
+
 ## Installation
 
-For Node.js, Mentor RDF comes as an [npm package](https://npmjs.org/package/n3).
+Works in Node.js (>=16) and modern browsers:
 
 ```bash
 npm install @faubulous/mentor-rdf
+```
+
+## Quick Start
+
+```typescript
+import { Store, VocabularyRepository, OwlReasoner } from '@faubulous/mentor-rdf';
+
+// Create a store with OWL reasoning
+const store = new Store(new OwlReasoner());
+
+// Load an ontology
+await store.loadFromTurtleStream(turtleData, 'http://example.org/my-ontology');
+
+// Query using repositories
+const repository = new VocabularyRepository(store);
+
+// Get all classes defined in the ontology
+for (const classUri of repository.getClasses('http://example.org/my-ontology')) {
+  console.log(classUri);
+}
+
+// Get class hierarchy (includes inferred subclass relationships)
+const subClasses = repository.getSubClasses('http://example.org/my-ontology', 'http://example.org/MyClass');
 ```