@csaf-rs/ssvc 0.1.0 → 0.2.1

package/README.md

@@ -1,11 +1,81 @@
-# ssvc
-Implementation of the SSVC specification in Rust
+# SSVC Rust Implementation
 
-## WASM Build
+A Rust implementation of the **SSVC (Stakeholder-Specific Vulnerability Categorization)** specification.
+SSVC is a framework for prioritizing software vulnerability remediation efforts. It helps stakeholders make informed decisions about which vulnerabilities to address first by considering factors like vulnerability severity, the stakeholder's position in the ecosystem, and their specific constraints.
+Learn more at the [official SSVC documentation](https://certcc.github.io/SSVC/).
 
-Build the WebAssembly artifact with:
+## Features
 
+This library provides validation and processing of SSVC decision points and selection lists, with support for SSVC namespaces and extensions.
+It features full serde support. The library supports both native Rust usage and WebAssembly (WASM) bindings for JavaScript/web applications.
+
+## Installation
+
+Add to your project:
+
+```bash
+cargo add ssvc
 ```
+
+## MSRV
+
+1.85.0
+
+## Examples
+
+### Rust
+
+```rust
+use ssvc::selection_list::SelectionList;
+use ssvc::validate_selection_list;
+
+let json_data = "..."; // Your SSVC selection list
+
+let selection_list: SelectionList =
+    serde_json::from_str(json_data).expect("SSVC SelectionList was invalid JSON");
+
+// Validate the selection list
+let result = validate_selection_list(&selection_list, false);
+
+if result.success {
+    println!("Selection list is valid!");
+} else {
+    for error in result.errors {
+        println!("Validation error: {}", error.message);
+    }
+}
+```
+
+### WebAssembly
+
+#### Build
+
+```bash
+# Install wasm-pack if you haven't already
 cargo install wasm-pack
+# Build for web
 wasm-pack build --target web --out-dir pkg -- --features wasm
 ```
+
+#### Usage
+
+```javascript
+import * as wasm from './pkg/ssvc.js';
+
+const jsonData = {...}; // Your SSVC selection list
+
+try {
+  const result = wasm.validateSelectionList(JSON.stringify(jsonData), false);
+  if (result.success) {
+    console.log("Valid SSVC data");
+  } else {
+    console.log("Validation errors:", result.errors);
+  }
+} catch (error) {
+  console.error("Error:", error);
+}
+```
+
+## License
+
+Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) file for details.

package/package.json

@@ -2,8 +2,12 @@
   "name": "@csaf-rs/ssvc",
   "type": "module",
   "description": "Implementation of the SSVC specification in Rust",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/csaf-rs/ssvc"
+  },
   "files": [
     "ssvc_bg.wasm",
     "ssvc.js",
@@ -11,10 +15,7 @@
   ],
   "main": "ssvc.js",
   "types": "ssvc.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
   "sideEffects": [
     "./snippets/*"
   ]
-}
+}