Browse Source

Update README.

scossu 1 year ago
parent
commit
666aefd54c
1 changed files with 13 additions and 5 deletions
  1. 13 5
      README.md

+ 13 - 5
README.md

@@ -22,6 +22,9 @@ either back end within the same program. Triples in the persistent back end are
 fully indexed and optimized for a balance of lookup speed, data compactness,
 fully indexed and optimized for a balance of lookup speed, data compactness,
 and write performance (in order of importance).
 and write performance (in order of importance).
 
 
+The code offers an interface to write a custom back end implementation with
+minimal changes to the core. More documentation on the topic will follow.
+
 This library was initially meant to replace RDFLib dependency and Cython code
 This library was initially meant to replace RDFLib dependency and Cython code
 in [Lakesuperior](https://notabug.org/scossu/lakesuperior) in an effort to
 in [Lakesuperior](https://notabug.org/scossu/lakesuperior) in an effort to
 reduce code clutter and speed up RDF handling; it is now a project for an
 reduce code clutter and speed up RDF handling; it is now a project for an
@@ -31,9 +34,13 @@ remain focused on serving Lakesuperior.
 
 
 ## Development Status
 ## Development Status
 
 
-**Alpha.** The API structure is not yet stable and may change radically. The
-code may not compile, or throw a fit when run. Testing is minimal. At the
-moment this project is only intended for curious developers and researchers.
+**Alpha.** Considered feature-complete from an MVP standpoint. The API may
+still change significantly. The code may not compile, or throw a fit when run.
+The Python API may be behind the C API and not work. Test coverage is not
+sufficient. Documentation is fairly extensive but needs reformatting. This code
+is being integrated in the higher-level `lsup_repo` project and is being
+improved as issues arise. The status will move to beta as soon as `lsup_repo`
+covers a significant range of `lsup_rdf` features.
 
 
 This is also my first stab at writing a C library (coming from Python) and an
 This is also my first stab at writing a C library (coming from Python) and an
 unpaid fun project, so don't be surprised if you find some gross stuff.
 unpaid fun project, so don't be surprised if you find some gross stuff.
@@ -60,13 +67,14 @@ of features as a standalone library:
 - Compile-time configuration of max graph size (efficiency vs. capacity)
 - Compile-time configuration of max graph size (efficiency vs. capacity)
 - Python bindings
 - Python bindings
 - Basic command line utilities
 - Basic command line utilities
+- Store interface for custom back end implementations
 
 
 ### Possibly In scope – Long Term
 ### Possibly In scope – Long Term
 
 
 - Binary serialization and hashing of graphs
 - Binary serialization and hashing of graphs
 - Binary protocol for synchronizing remote replicas
 - Binary protocol for synchronizing remote replicas
 - Support for non-local, software-defined storage (e.g. S3)
 - Support for non-local, software-defined storage (e.g. S3)
-- Lua bindings
+- True plug-in architecture for 3rd-party store implementations
 
 
 ### Likely Out of Scope
 ### Likely Out of Scope
 
 
@@ -74,7 +82,7 @@ of features as a standalone library:
 
 
 - C++ bindings
 - C++ bindings
 - JSON-LD de/serialization
 - JSON-LD de/serialization
-- SPARQL queries (We'll see... Will definitely need help)
+- SPARQL support
 
 
 ## Building
 ## Building