@0xsarwagya/ontoly-core 0.1.0-alpha.2 → 1.0.0-rc.3

package/README.md

@@ -1,8 +1,14 @@
 # @0xsarwagya/ontoly-core
 
-Software Graph schema, stable IDs, indexes, and graph helpers for Ontoly.
+## Responsibility
 
-This package is part of [Ontoly](https://github.com/0xsarwagya/ontoly), a TypeScript-native software intelligence engine that builds a deterministic Software Graph.
+`@0xsarwagya/ontoly-core` is the innermost package. It owns Software Graph
+contracts, stable IDs, graph helpers, graph validation primitives, and shared
+graph/index data structures. It does not discover repositories, parse source,
+run the compiler pipeline, expose transport, or render artifacts.
+
+See the repository [architecture map](../../ARCHITECTURE.md) for package
+boundaries.
 
 ## Installation
 
@@ -10,9 +16,24 @@ This package is part of [Ontoly](https://github.com/0xsarwagya/ontoly), a TypeSc
 pnpm add @0xsarwagya/ontoly-core
 ```
 
+## API
+
+- Software Graph node, edge, diagnostic, metadata, and index types.
+- Stable ID helpers and graph utility functions.
+- Semantic Index primitives shared by CLI, capabilities, and validation.
+
+## Example
+
+```ts
+import { createNodeId, createSemanticIndex } from "@0xsarwagya/ontoly-core";
+
+const id = createNodeId("Function", "src/auth.ts", "login");
+const index = createSemanticIndex(graph);
+```
+
 ## Status
 
-Alpha package for Ontoly v0.1.0-alpha.2. The public API is versioned with the Software Graph and RFC process.
+Release Candidate package for Ontoly v1.0.0-rc.3. Public contracts are governed by the Software Graph specification and RFC process.
 
 ## Links